Replace the TODO by a explanation of the limits
#2308
Conversation
This file contains 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
sfauvel
temporarily deployed
to
testing-preview
GitHub Actions
Inactive
sfauvel
temporarily deployed
to
testing-sanchonet
GitHub Actions
Inactive
dlachaume
approved these changes
Feb 13, 2025
internal/mithril-doc/src/lib.rs
Outdated
| @@ -1,6 +1,6 @@ | |||
| //! Commands to generate a markdown documentation for the command line. | |||
| // TODO: Some Configuration could not be generated properly because there is a lack of information. | |||
| // LIMITATIONS: Some `Configuration` cannot be generated as precisely as we would like because there is a lack of information in code. | |||
There was a problem hiding this comment.
Suggested change
| // LIMITATIONS: Some `Configuration` cannot be generated as precisely as we would like because there is a lack of information in code. | |
| // LIMITATIONS: Some `Configuration` cannot be generated as precisely as we would like because there is a lack of information in the code. |
sfauvel
temporarily deployed
to
testing-preview
GitHub Actions
Inactive
sfauvel
had a problem deploying
to
testing-sanchonet
GitHub Actions
Failure
sfauvel
temporarily deployed
to
testing-sanchonet
GitHub Actions
Inactive
sfauvel
force-pushed
the
sfa/remove_todo_from_mithril_doc_module
branch
from
3ae69e0 to
a8e0f9f
Compare
sfauvel
temporarily deployed
to
testing-preview
GitHub Actions
Inactive
sfauvel
temporarily deployed
to
testing-sanchonet
GitHub Actions
Inactive
jpraynaud
approved these changes
Feb 14, 2025
Alenar
approved these changes
Feb 14, 2025
| @@ -45,6 +45,7 @@ impl MainCommand { | |||
| Self::Serve(cmd) => cmd.execute(root_logger, config_builder).await, | |||
| Self::Tools(cmd) => cmd.execute(root_logger, config_builder).await, | |||
| Self::GenerateDoc(cmd) => { | |||
| println!("Please note: the documentation generated is not able to indicate the environment variables used by the commands."); | |||
There was a problem hiding this comment.
Is this the correct location for this println ? Should it be in mithril-doc instead ?
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.
Content
Remove a
TODOand replace it by a message indicated the limitation of the documentation generated.Pre-submit checklist