Add reference documentation #47
Merged
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
lenzip
reviewed
Jun 21, 2024
src/cmsstyle/cmsstyle.py
Outdated
| @@ -31,6 +46,12 @@ def SetLumi(lumi, unit="fb", round_lumi=False): | |||
|
|
|||
|
|
|||
| def SetExtraText(text): | |||
| """ | |||
| Set extra text to be displayed. | |||
There was a problem hiding this comment.
One could maybe add: Set extra text to be displayed next to "CMS", e.g. "Preliminary".
src/cmsstyle/cmsstyle.py
Outdated
| global additionalInfo | ||
| additionalInfo = [] | ||
|
|
||
| def AppendAdditionalInfo(text): | ||
| """ | ||
| Append additional information to be displayed. |
There was a problem hiding this comment.
also here, one could provide and example, e.g. a string identifying a region, or its selection.
|
Thanks, updated |
lenzip
approved these changes
Jun 21, 2024
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.
Based on mkdocs with mkdocs-material theme and mkdocstrings for automated reference generation.
I've added lots of docstrings so that the documentation gets populated.
Will as a next step then finalise registration with readthedocs.
Closes #34