Skip to content

[docs] Supplement documentation overrides HelpText #1119

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

Open
quic-seaswara wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[docs] Supplement documentation overrides HelpText #1119

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
9 changes: 5 additions & 4 deletions docs/userguide/GenerateOptionsDocsFromTblGen.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,7 @@ def generate_docs(self, out, supplement=None):
return
out.write(".. option:: " + ", ".join(option_forms))
out.write("\n")
if self.help_text:
out.write("\n")
out.write(self.help_text)
out.write("\n")
# supplement overrides helptext
if supplement:
out.write("\n")
# Indent every line of the supplement by 3 spaces so it sits
Expand All @@ -94,6 +91,10 @@ def generate_docs(self, out, supplement=None):
)
out.write(indented)
out.write("\n")
elif self.help_text:
out.write("\n")
out.write(self.help_text)
out.write("\n")

@classmethod
def fixHelpTextFormatting(self, help_text):
Expand Down
Loading