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

Remove CLI option true defaults to enable negation #5582

Merged
merged 1 commit into from
Dec 4, 2022
Merged

Remove CLI option true defaults to enable negation #5582

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions aptos-move/framework/src/docgen.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ pub struct DocgenOptions {
#[clap(long)]
pub include_impl: bool,

/// Whether to include specifications in the generated documentation. Defaults to true.
#[clap(long, global = true)]
/// Whether to include specifications in the generated documentation. Defaults to false.
#[clap(long)]
pub include_specs: bool,
Comment on lines -18 to 20
Copy link
Contributor

Choose a reason for hiding this comment

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

The other option is we can make it exclude_specs. This still lets it default to true, but allows for negation.

Copy link
Contributor

Choose a reason for hiding this comment

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

It is probably fine.


/// Whether specifications should be put side-by-side with declarations or into a separate
Expand All @@ -29,8 +29,8 @@ pub struct DocgenOptions {
pub include_dep_diagram: bool,

/// Whether details should be put into collapsed sections. This is not supported by
/// all markdown, but the github dialect. Defaults to true.
#[clap(long, global = true)]
/// all markdown, but the github dialect. Defaults to false.
#[clap(long)]
pub collapsed_sections: bool,

/// Package-relative path to an optional markdown template which is a used to create a
Expand Down