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

[doc] Use long options in places #3197

Conversation

createyourpersonalaccount
Copy link
Contributor

Long options are more self-documenting.

@jenkins-cscs
Copy link
Collaborator

Can I test this patch?

Copy link
Contributor

@vkarak vkarak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with this particular suggestion but not in general. In the command examples in the tutorial the short options are used, so if the option is mentioned in the text, it has to match that in the example.

If you rebase this on master, it'll be good to merge. Thanks!

@vkarak vkarak added this to the ReFrame 4.7 milestone May 16, 2024
Long options are more self-documenting.
@createyourpersonalaccount createyourpersonalaccount changed the base branch from develop to master May 17, 2024 02:32
@createyourpersonalaccount
Copy link
Contributor Author

@vkarak done!

@vkarak vkarak changed the title in docs prefer long options to short options [doc] Use long options in places May 17, 2024
@vkarak vkarak merged commit f0f27e2 into reframe-hpc:master May 17, 2024
22 checks passed
@createyourpersonalaccount createyourpersonalaccount deleted the fixing-tutorial-long-links branch May 17, 2024 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants