Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fixes backticks for doc strings #2174

Merged
merged 2 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/cli/add.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ use crate::{
/// Adds dependencies to the project
///
/// The dependencies should be defined as MatchSpec for conda package, or a PyPI
/// requirement for the --pypi dependencies. If no specific version is provided,
/// requirement for the `--pypi` dependencies. If no specific version is provided,
/// the latest version compatible with your project will be chosen automatically
/// or a * will be used.
///
Expand Down
2 changes: 1 addition & 1 deletion src/cli/cli_config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ use std::path::PathBuf;
/// Project configuration
#[derive(Parser, Debug, Default)]
pub struct ProjectConfig {
/// The path to 'pixi.toml' or 'pyproject.toml'
/// The path to `pixi.toml` or `pyproject.toml`
#[arg(long)]
pub manifest_path: Option<PathBuf>,
}
Expand Down
2 changes: 1 addition & 1 deletion src/cli/completion.rs
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ _arguments "${_arguments_options[@]}" \
# Runs task in project
export extern "pixi run" [
...task: string # The pixi task or a task shell command you want to run in the project's environment, which can be an executable in the environment's PATH
--manifest-path: string # The path to 'pixi.toml' or 'pyproject.toml'
--manifest-path: string # The path to `pixi.toml` or `pyproject.toml`
--frozen # Install the environment as defined in the lockfile, doesn't update lockfile if it isn't up-to-date with the manifest file
--locked # Check if lockfile is up-to-date before installing the environment, aborts when lockfile isn't up-to-date with the manifest file
--environment(-e): string # The environment to run the task in
Expand Down
2 changes: 1 addition & 1 deletion src/cli/project/channel/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use std::path::PathBuf;
/// Commands to manage project channels.
#[derive(Parser, Debug)]
pub struct Args {
/// The path to 'pixi.toml' or 'pyproject.toml'
/// The path to `pixi.toml` or `pyproject.toml`
#[clap(long, global = true)]
pub manifest_path: Option<PathBuf>,

Expand Down
2 changes: 1 addition & 1 deletion src/cli/project/description/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use std::path::PathBuf;
/// Commands to manage project description.
#[derive(Parser, Debug)]
pub struct Args {
/// The path to 'pixi.toml' or 'pyproject.toml'
/// The path to `pixi.toml` or `pyproject.toml`
#[clap(long, global = true)]
pub manifest_path: Option<PathBuf>,

Expand Down
2 changes: 1 addition & 1 deletion src/cli/project/environment/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use std::path::PathBuf;
/// Commands to manage project environments.
#[derive(Parser, Debug)]
pub struct Args {
/// The path to 'pixi.toml' or 'pyproject.toml'
/// The path to `pixi.toml` or `pyproject.toml`
#[clap(long, global = true)]
pub manifest_path: Option<PathBuf>,

Expand Down
2 changes: 1 addition & 1 deletion src/cli/project/export/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use clap::Parser;
/// Commands to export projects to other formats
#[derive(Parser, Debug)]
pub struct Args {
/// The path to 'pixi.toml' or 'pyproject.toml'
/// The path to `pixi.toml` or `pyproject.toml`
#[clap(long, global = true)]
pub manifest_path: Option<PathBuf>,

Expand Down
2 changes: 1 addition & 1 deletion src/cli/project/platform/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use std::path::PathBuf;
/// Commands to manage project platforms.
#[derive(Parser, Debug)]
pub struct Args {
/// The path to 'pixi.toml' or 'pyproject.toml'
/// The path to `pixi.toml` or `pyproject.toml`
#[clap(long, global = true)]
pub manifest_path: Option<PathBuf>,

Expand Down
2 changes: 1 addition & 1 deletion src/cli/project/version/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use std::path::PathBuf;
/// Commands to manage project version.
#[derive(Parser, Debug)]
pub struct Args {
/// The path to 'pixi.toml' or 'pyproject.toml'
/// The path to `pixi.toml` or `pyproject.toml`
#[clap(long, global = true)]
pub manifest_path: Option<PathBuf>,

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ expression: result
# Runs task in project
export extern "pixi run" [
...task: string@"nu-complete pixi run" # The pixi task or a task shell command you want to run in the project's environment, which can be an executable in the environment's PATH
--manifest-path: string # The path to 'pixi.toml' or 'pyproject.toml'
--manifest-path: string # The path to `pixi.toml` or `pyproject.toml`
--frozen # Install the environment as defined in the lockfile, doesn't update lockfile if it isn't up-to-date with the manifest file
--locked # Check if lockfile is up-to-date before installing the environment, aborts when lockfile isn't up-to-date with the manifest file
--environment(-e): string@"nu-complete pixi run environment" # The environment to run the task in
Expand Down
Loading