doc: shorten grayskull usage by one step#2222
doc: shorten grayskull usage by one step#2222corneliusroemer wants to merge 3 commits intoconda-forge:mainfrom
Conversation
- It's more user friendly to provide ready to execute commands, e.g. an environment named `grayskull` makes sense if it's just `grayskull` that's installed there. - One can directly install grayskull upon env creation, this reduces the docs by one line, and also makes it faster to run
✅ Deploy Preview for conda-forge-previews ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| - Activate this new environment : `conda activate MY_ENV`. | ||
| - Run `conda install -c conda-forge grayskull` to install `grayskull`. | ||
| - Followed by `grayskull pypi --strict-conda-forge YOUR_PACKAGE_NAME` to generate the recipe. Replace `YOUR_PACKAGE_NAME` with the package name. | ||
| - Create a new environment named e.g. "grayskull" with grayskull installed : `conda create --name grayskull -c conda-forge grayskull` |
There was a problem hiding this comment.
Please use a different name for the env. grayskull_env or similar to avoid confusion.
jaimergp
left a comment
jaimergp
left a comment
There was a problem hiding this comment.
IMO, conda create ... + conda activate ... is very common in the ecosystem. It's true that conda run saves one command, but it comes its overheads too (see the output capture issue).
I'd rather have this mentioned as an alternative way of achieving the same thing. It would be a good way of educating the community as well, because this mini tutorial is usually an entry point for beginners.
Something like
[ ORIGINAL INSTRUCTIONS ]
Alternatively, you can save yourself one command and use
conda runto executegrayskull. In other words:
- Create an environment with
grayskull:... command here ...- Run grayskull from that new environment:
... command here ....
WDYT? I'd be more comfortable approving this variant that currently presented one.
Co-authored-by: jaimergp <jaimergp@users.noreply.github.com>
3 participants
grayskullmakes sense if it's justgrayskullthat's installed there.conda run -n grayskullto avoid having to activate the created environment, saving yet another line and a few keystrokes