Improved experience with MLCube help in console environments.#321
Merged
sergey-serebryakov merged 1 commit intoJul 25, 2023
Merged
Conversation
- Updating documentation for config command. - Various improvements in command line-based help pages: - Fixing bugs related in markdown-to-text conversion. - Keeping code blocks as is in textual format (wrapped with ``, e.g., `pip install cookiecutter`). - Introducing new and renaming existing sections in console-based help messages: "Brief description", "Long description", "Options" and "Examples". - The doc strings can now contain on <long>very long description</long> block. This will not be part of console-based help, but will be part of web-based documentation pages. - Simplifying logic that's used to print epilogues (example usages).
Contributor
|
MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅ |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
pip install cookiecutter).