Skip to content

📝Document Enum Members by using #:; Remove 🔥 DocStrEnum approach that turned out to not work#78

Merged
hf-kklein merged 1 commit intodevelopfrom
enumdocs_again
Nov 17, 2021
Merged

📝Document Enum Members by using #:; Remove 🔥 DocStrEnum approach that turned out to not work#78
hf-kklein merged 1 commit intodevelopfrom
enumdocs_again

Conversation

@hf-kklein
Copy link
Copy Markdown
Contributor

@hf-kklein hf-kklein commented Nov 16, 2021

The last approaches to have documented enum members (not only classes) on read the docs resulted in a heuristic trial and error development process (see #75).

Now here's the next step to ultimate documentation truth on how to really do it (aka "richtig statt falsch"):

Works on my machine:
grafik

remove unnecessary tests and code
update the docs
@hf-kklein hf-kklein self-assigned this Nov 16, 2021
@hf-kklein hf-kklein changed the title Hopefully last approach to enum documentation Hopefully last approach to proper enum member documentation Nov 16, 2021
@hf-kklein hf-kklein changed the title Hopefully last approach to proper enum member documentation Hopefully last approach to proper enum member documentation; Remove 🔥 Code Introduced in #75 Nov 16, 2021
@hf-kklein hf-kklein changed the title Hopefully last approach to proper enum member documentation; Remove 🔥 Code Introduced in #75 📝Hopefully last approach to proper enum member documentation; Remove 🔥 older Approach Nov 16, 2021
@hf-kklein hf-kklein changed the title 📝Hopefully last approach to proper enum member documentation; Remove 🔥 older Approach 📝Hopefully last approach to proper enum member documentation; Remove 🔥 DocStrEnum that didn't work Nov 16, 2021
@hf-kklein hf-kklein changed the title 📝Hopefully last approach to proper enum member documentation; Remove 🔥 DocStrEnum that didn't work 📝Document Enum Member by using #:; Remove 🔥 DocStrEnum approach that turned out to not work Nov 16, 2021
@hf-kklein hf-kklein changed the title 📝Document Enum Member by using #:; Remove 🔥 DocStrEnum approach that turned out to not work 📝Document Enum Members by using #:; Remove 🔥 DocStrEnum approach that turned out to not work Nov 16, 2021
@hf-kklein hf-kklein requested review from a team, hf-aschloegl and hf-krechan and removed request for hf-krechan November 16, 2021 17:40
Copy link
Copy Markdown
Collaborator

@hf-aschloegl hf-aschloegl left a comment

Choose a reason for hiding this comment

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

Ja, schicke Sache 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants