📝🎨update enum member documentation to sphinx compatible format#81
Merged
📝🎨update enum member documentation to sphinx compatible format#81
Conversation
hf-krechan
requested changes
Nov 29, 2021
Collaborator
hf-krechan
left a comment
hf-krechan
left a comment
There was a problem hiding this comment.
Just the question what is the purpose of : and if it's important, one enum entry is missing it.
| .. code-block:: Shell | ||
|
|
||
| "$wert": "$wert", # $bedeutung | ||
| "$wert": "$wert", #: $bedeutung |
Collaborator
There was a problem hiding this comment.
What is the purpose of the :?
src/bo4e/enum/themengebiet.py
Outdated
| BILANZKREISKOORDINATOR = "BILANZKREISKOORDINATOR" #: Bilanzkreiskoordinator | ||
| BILANZKREISVERANTWORTLICHER = "BILANZKREISVERANTWORTLICHER" #: Bilanzkreisverantwortlicher | ||
| DATENFORMATE_ZERTIFIKATE_VERSCHLUESSELUNGEN = ( | ||
| "DATENFORMATE_ZERTIFIKATE_VERSCHLUESSELUNGEN" # Datenformate, Zertifikate, Verschlüsselungen |
Collaborator
There was a problem hiding this comment.
The : is here missing, isn't it?
Contributor
Author
There was a problem hiding this comment.
probably my regex search and replace failed for those entries... maybe because they span multiple lines.
Contributor
Author
see #78 it's described there including minimal examples (tl;dr: doc entries for enum members with trailing |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Repeates the steps from #78 for all enum (member)s