Improve documentation #101
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
for more information, see https://pre-commit.ci
|
Do we really need doc8 to annoy us if the line is too long? I thought we discussed this at some point and anyway one would use alt+z in vscode or something for writing doc |
|
To check the compiled version you can have a look here 😊 |
Agreed, if possible I would remove all linting of docfiles. |
Pull Request Test Coverage Report for Build 6694151483
💛 - Coveralls |
kdund
approved these changes
Oct 30, 2023
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.
I started writing some documentation a couple of weeks ago but I can't find the time to finish it the next time.
However, I think the things that are added are already helpful for beginners. For this reason, I would suggest merging it at this stage and then we can pick it up from this point the next time someone has time to write something.