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

Examples in docs may be outdated #1065

Open
mjuric opened this issue Nov 21, 2024 · 1 comment
Open

Examples in docs may be outdated #1065

mjuric opened this issue Nov 21, 2024 · 1 comment

Comments

@mjuric
Copy link
Member

mjuric commented Nov 21, 2024

While implementing the cmdline option update PR, I noticed some of the docs may be out of date. E.g. https://sorcha.readthedocs.io/en/latest/gettingstarted.html shows the old sorcha --help result (even before we switched to sorcha <verb> scheme).

I'm not sure how these are (auto-?) generated & I'm worried I'll break something if I go and manually change the example files, so I'm just making a note here for someone to scrub the docs before v1.0:

image
@mschwamb
Copy link
Collaborator

mschwamb commented Nov 21, 2024

yep docs haven't been finished. We're waiting for the linux conversion of commands before fixing things/finishing the docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants