-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
UseShortOptionHandling not found in v1.21.0 #877
Comments
The PR for that was merged 21 days ago #735, whereas IME more mature projects solve this problem have having docs links that are specific to the version, like this page for example https://bundler.io/v1.15/man/bundle-config.1.html which is for bundler |
I see there is a big discrepancy here. I checked the tree of the 1.21.0 release. There is no UseShortOptionHandling option defined although the README.md encourages us to do so. Please check: and https://github.com/urfave/cli/blob/e6cf83ec39f6e1158ced1927d4ed14578fda8edb/app.go |
Ah, my comment may not have been clear enough! |
In the future we can implement a policy of only updating the readme as a part of new version releases, or something similar. This problem will continue coming up unless something changes about the way versions are released 🙁 |
There is actually support for The README for 1.21.0 references the |
I agree that this is important, and probably the real core of the issue here. I'm not a huge fan of avoiding updating the README until release because it means that the people with the best understanding of the feature (i.e., the feature authors) would no longer be the people responsible for the documentation. Between that, and the fact that all the docs would have to be written at all once, potentially long after the feature was merged, the quality of docs might be taking a hit. One relatively popular alternative is using static documentation generators such as mkdocs, docsify, or docusaurus, among others, to build a GitHub Pages site from a docs folder, which can be linked to in the README. The published version is always the latest tagged version, and every version is still available alongside the source code. The overhead is pretty small, and it's a one-time upfront cost that can be automated in CI rather than a change in process. |
^ this is the solution I would prefer! |
I propose: we close this issue, and create another issue about setting up a "versioned documentation" system (described above) |
Hi guys,
First of all great job! It's an amazing framework!
I'm relatively new to Go and most of all to Go Modules, so I'm almost sure that I'm doing something wrong.
But I found something weird in the flag App.UseShortOptionHandling.
In my example to understand the framework, I copied/pasted your sample about Combining short options in this file but for some reason the compiler complains about
What do I miss? What do I wrong?
Thanks for your help
The text was updated successfully, but these errors were encountered: