ParaView: correct uenv labels in doc #313
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I start this PR by normalizing uenv labels in ParaView doc, but the main point is understanding what should be done for uenv labels in docs.
On one side I understand that it's nicer if all the commands just works by copy-paste, in which case being specific on a uenv label is required, not just for pull but for all uenv usages (e.g. avoiding possible name ambiguity resulting in command not being executed).
On the contrary, it is a bit of a burden to remember to update the doc whenever a new uenv gets released. In that case, we should have some kind of release prodedure for uenvs that helps checking that the related documentation gets updated as well.
I'm inclined to think that docs should work copy-paste just for very brand new user, in order to lower the obstacle the first time. With time users get more knowledgeable about tools like uenv, and they can deal with commands that might not work because the copy-paste leads to an ambiguity in usage of a uenv (e.g because multiple ones are available). It is also true that, AFAIK, there's no
:latesttag for uenvs, so at least thepullrequires to be very specific about the tag.Looking forward for suggestions and/or guidelines.
@bcumming @msimberg @RMeli looking forward to your knowledge and experience with uenvs.