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

Recipes using the same libraries are indistinguishable #2564

Open
richardhuxton opened this issue Jul 1, 2024 · 2 comments
Open

Recipes using the same libraries are indistinguishable #2564

richardhuxton opened this issue Jul 1, 2024 · 2 comments
Labels
bug Something isn't working

Comments

@richardhuxton
Copy link

richardhuxton commented Jul 1, 2024

Screenshot 2024-07-01 22 42 09

For the cookbook entries covering "command line arguments" I made one recipe using Cmdliner and two using the standard-library (once with Sys.argv and once with Arg). Of course you can't tell the two apart on the listing.

It feels like the simplest fix might be to add a new field in the yaml header title_postscript: " (Argv)" so the displayed title can be "using the Standard Library (Argv)". I'm happy to try and put a patch together if this sort of approach would be acceptable.

@richardhuxton
Copy link
Author

I temporarily merged the two recipes into one for my submission. Having had a think about it, it perhaps makes more sense to have a recipe_title which would be just be the whole displayed title (if present), otherwise fall back to using the library name.

@cuihtlauac cuihtlauac added the bug Something isn't working label Jul 5, 2024
@sabine
Copy link
Collaborator

sabine commented Aug 5, 2024

Hey, sorry for the late answer. My opinion on this is that there is hardly any value in proposing multiple recipes using the same libraries. This only creates choice paralysis for the reader.

That's why just showing one way to do things is fine. The only requirement is that it should be code that you wouldn't be ashamed of copying into a production codebase.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: 📋 Backlog
Development

No branches or pull requests

3 participants