-
-
Notifications
You must be signed in to change notification settings - Fork 5.9k
Add note about which version embedded tool is implemented #10255
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
Add note about which version embedded tool is implemented #10255
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small nit, otherwise LGTM
Co-Authored-By: John Olheiser <[email protected]>
Codecov Report
@@ Coverage Diff @@
## master #10255 +/- ##
==========================================
- Coverage 43.58% 43.57% -0.01%
==========================================
Files 583 583
Lines 80266 80266
==========================================
- Hits 34980 34975 -5
- Misses 40951 40956 +5
Partials 4335 4335
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a difficult choice since "is included in versions 1.12 and above" implies that those versions are already released (our downloads page doesn't have an 1.12
folder). I thought about this when I wrote the docs for that and for other features.
I understand that we can't start adding "when released" everywhere, because that becomes obsolete easily. One possible solution for this is having different repositories for code and docs, so docs can follow its own release/backport pattern.
As for this case in particular, this message is good enough.
@guillep2k sadly we've tried separate repo for docs before, and it caused no docs to be added at all. |
Other possible ways out of this conundrum:
|
as title