Docs work in progress #546
Draft
Conversation
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
Contributor
|
Hey! Just had a look at this since it's been floating around for a while. Maybe we can get some clarification on the function comments from @fengelniederhammer or so, and then we remove the Or we can move it out of 'in progress' if it's not urgent to finish this. |
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.
Summary
This is documentation work I currently have pending; not ready to merge, just so you could see what I'm doing.
The function documentation and types is probably useful, but has "XX" markers for open questions, and I'll probably have more of those documentation pieces over time.
The components.md is just an attempt at getting an overview; it probably will never be useful to merge, at least not in this form.