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.

Sign up for GitHub

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

Jump to bottom

[doc] Using details/summary in md files to show help message #3154

Merged
merged 1 commit into from
Jan 27, 2021
Merged

[doc] Using details/summary in md files to show help message #3154

merged 1 commit into from
Jan 27, 2021
+186 −6

Conversation

csordasmarton
Copy link
Contributor

The documentation files contain a lot command line help messages in raw
format and this way it is hard to read the docs. For this reason with this
patch we will use the HTML5 details feature which will collapse the help
messages by default and it will not take up so much space.

@csordasmarton csordasmarton added documentation 📖 Changes to documentation. usability 👍 Usability-related features labels Jan 20, 2021
@csordasmarton csordasmarton added this to the release 6.16.0 milestone Jan 20, 2021
@csordasmarton csordasmarton requested a review from bruntib January 20, 2021 13:13
@csordasmarton csordasmarton requested a review from dkrupp as a code owner January 20, 2021 13:13
bruntib
bruntib requested changes Jan 22, 2021
View reviewed changes
Copy link
Contributor

@bruntib bruntib left a comment

Choose a reason for hiding this comment

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

I think we shouldn't set sh as the language of verbatim parts, because this tries to syntax highlight help messages as if these were shell scripts. This results strange formatting when using shell keywords in these plain texts or using apostrophes.

@csordasmarton
[doc] Using details/summary in md files to show help message
6297041 
The documentation files contain a lot command line help messages in raw
format and this way it is hard to read the docs. For this reason with this
patch we will use the HTML5 details feature which will collapse the help
messages by default and it will not take up so much space.
@csordasmarton csordasmarton force-pushed the use_summary_in_md_files branch from cc807c7 to 6297041 Compare January 25, 2021 09:55
@csordasmarton csordasmarton requested a review from bruntib January 25, 2021 09:56
@bruntib bruntib merged commit b985700 into Ericsson:master Jan 27, 2021
@csordasmarton csordasmarton deleted the use_summary_in_md_files branch March 10, 2021 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bruntib bruntib bruntib approved these changes

@dkrupp dkrupp Awaiting requested review from dkrupp dkrupp is a code owner

Assignees
No one assigned
Labels
documentation 📖 Changes to documentation. usability 👍 Usability-related features
Projects
None yet
Milestone
release 6.15.1
Development

Successfully merging this pull request may close these issues.
2 participants
@csordasmarton @bruntib