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

changed auto generation info line from header to italics #2056

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

milanmayr
Copy link

resolves #2054

@CLAassistant
Copy link

CLAassistant commented Oct 25, 2023

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the area/docs-generation Generation of docs via Cobra label Oct 25, 2023
Copy link
Collaborator

@jpmcb jpmcb left a comment

Choose a reason for hiding this comment

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

This overall looks good to me: I'll leave it open for abit to get opinions from others. This may be abit unnecessary since typically people set this bool to true to entirely disable this auto generated tag:

cobra/command.go

Lines 237 to 239 in 8b1eba4

// DisableAutoGenTag defines, if gen tag ("Auto generated by spf13/cobra...")
// will be printed by generating docs for this command.
DisableAutoGenTag bool

I know that I turn it off anytime I'm auto-generating documentation.

doc/md_docs.go Outdated Show resolved Hide resolved
@jpmcb jpmcb added the kind/cleanup General cleanup of code, issues, etc. label Oct 28, 2023
Co-authored-by: John McBride <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs-generation Generation of docs via Cobra kind/cleanup General cleanup of code, issues, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc.GenMarkdownTree() annotation at the bottom gets interpreted by mkdocs as a navigational section
3 participants