Improve Documentation #822
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
hf-fvesely
reviewed
Jun 3, 2024
Comment on lines
+8
to
+9
| Our project has already benefited from the contributions of amazing developers. | ||
| We're excited to see your name join this list! |
There was a problem hiding this comment.
Wollen wir die beiden Zeilen weglassen? Ich habe das Gefüglh wir wiederholen uns zu sehr
There was a problem hiding this comment.
ich finde sie nicht schlimm, kann sie aber auch gerne entfernen
There was a problem hiding this comment.
nee so schlimm finde ich sie auch nicht, kann auch bleiben 😁
hf-fvesely
reviewed
Jun 3, 2024
docs/index.rst
Outdated
|
|
||
| Contents | ||
| ======== | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
|
|
||
| License <license> | ||
| Authors <authors> | ||
| Introduction <introduction> |
There was a problem hiding this comment.
Das ist jetzt irgednwie doppelt hier drin oder muss das so?
Ich glaube wir haben fundementals, statt Introduction. Vielleicht failed deswegen auch die doku-action?
There was a problem hiding this comment.
good catch! Ja da ist mir ein Fehler unterlaufen.
Fixed in 0db4ebc
hf-fvesely
reviewed
Jun 6, 2024
docs/index.rst
Outdated
| License <license> | ||
| Authors <authors> | ||
| Fundamentals <fundamentals> | ||
| Data model <api/modules> |
There was a problem hiding this comment.
Suggested change
| Data model <api/modules> | |
| Data Model <api/modules> |
hf-fvesely
approved these changes
Jun 6, 2024
hf-fvesely
reviewed
Jun 6, 2024
| @@ -53,8 +53,8 @@ All Enums inherit from ``bo4e.enum.StrEnum``. The latter is just a usual Enum wi | |||
| EIGENSCHAFT_0815 = "0815" #: manchmal heißen eigenschaften anders (EIGENSCHAFT_0815) als sie serialisiert werden ("0815") | |||
| # this typically happens for annoying enum values that contains "-" or start with digits | |||
|
|
|||
| How to Define `COM`s or `BO`s | |||
| ----------------------------- | |||
| How to Define COMs or BOs | |||
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.
No description provided.