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

Documentation: Add Description of package_spec (or reference to) #11426

Open
4 tasks done
phreed opened this issue Apr 22, 2022 · 2 comments
Open
4 tasks done

Documentation: Add Description of package_spec (or reference to) #11426

phreed opened this issue Apr 22, 2022 · 2 comments
Labels
backlog issue has been triaged but has not been earmarked for any upcoming release source::community catch-all for issues filed by community members stale::recovered [bot] recovered after being marked as stale stale [bot] marked as stale due to inactivity type::documentation request for improved documentation

Comments

@phreed
Copy link

phreed commented Apr 22, 2022

Checklist

  • I added a descriptive title
  • I searched for other issues and couldn't find a solution or duplication
  • I already searched in Google and didn't find any good information or help
  • I looked at the docs and didn't see anything to help

What happened?

There is no documentation covering package_spec which is used in several commands e.g. install, create, and update.

p.add_argument(
'packages',
metavar='package_spec',
action="store",
nargs='*',
help="Packages to install or update in the conda environment.",
)

The documentation can be found in https://docs.conda.io/projects/conda-build/en/latest/resources/package-spec.html#package-match-specifications
Should the documentation be added to this repository?
Should a reference be made into the conda-build documentation?

Conda info

Not relevant.

Conda config

Not relevant

Conda list

Not relevant

Additional Context

Not relevant

@phreed phreed added the type::bug describes erroneous operation, use severity::* to classify the type label Apr 22, 2022
@beeankha beeankha added source::community catch-all for issues filed by community members type::documentation request for improved documentation backlog issue has been triaged but has not been earmarked for any upcoming release and removed type::bug describes erroneous operation, use severity::* to classify the type labels May 10, 2022
@github-actions
Copy link

Hi there, thank you for your contribution!

This issue has been automatically marked as stale because it has not had recent activity. It will be closed automatically if no further activity occurs.

If you would like this issue to remain open please:

  1. Verify that you can still reproduce the issue at hand
  2. Comment that the issue is still reproducible and include:
    - What OS and version you reproduced the issue on
    - What steps you followed to reproduce the issue

NOTE: If this issue was closed prematurely, please leave a comment.

Thanks!

@github-actions github-actions bot added the stale [bot] marked as stale due to inactivity label May 12, 2023
@github-actions github-actions bot added the stale::closed [bot] closed after being marked as stale label Jun 12, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jun 12, 2023
@jezdez jezdez reopened this Jun 13, 2023
@jezdez jezdez added stale::recovered [bot] recovered after being marked as stale and removed stale::closed [bot] closed after being marked as stale labels Jun 13, 2023
@roccomoretti
Copy link

Agree that some sort of cross-reference for the package specification syntax specification should show up in https://docs.conda.io/projects/conda/en/latest/commands/install.html

Related to this, if https://github.com/conda/conda/blob/main/docs/source/user-guide/concepts/pkg-specs.rst#package-match-specifications is the relevant documentation, it has rather confusing phrasing -- At the top it states: "This match specification is not the same as the syntax used at the command line with conda install", but then later on it gives examples that explicitly uses conda install. It's unclear what "is not the same" implies about the syntax in various use cases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog issue has been triaged but has not been earmarked for any upcoming release source::community catch-all for issues filed by community members stale::recovered [bot] recovered after being marked as stale stale [bot] marked as stale due to inactivity type::documentation request for improved documentation
Projects
Status: 🏗️ In Progress
Development

No branches or pull requests

4 participants