This repository was archived by the owner on Jun 1, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 97
Add a user guide #247
Open
Open
Add a user guide #247
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
@mattt
mattt
force-pushed
the
master
branch
2 times, most recently
from
April 26, 2021 13:20
18b4d97 to
81f2d3a
Compare
@Lukas-Stuehrk
Lukas-Stuehrk
force-pushed
the
UserGuide
branch
from
May 4, 2021 16:09
947c508 to
b335ca0
Compare
davegomez
commented
Jun 4, 2021
I'm looking for something like this.
My doubt is how should I document a return value when is optional?
Should I just mention it in the comment and the generator will take the Optional Type automatically setting the difference somewhere?
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This is a discussion starter. It's a first try to explore the structure and contents of a user guide. I think it implements #73. It uses a lot of functionality of the upcoming
1.0.0-beta.6release, so we should not merge it before this version is released.Please feel free to change, extend and rework this. Also, in its current form it's rather boring 🇩🇪 and we might want to make it more exciting.
Also: English is not my first language, so it could benefit from improvements of a native speaker with good writing skills.