Skip to content
This repository has been archived by the owner on Jun 1, 2023. It is now read-only.

Add a user guide #247

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Lukas-Stuehrk
Copy link
Member

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.6 release, 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.

@mattt mattt force-pushed the master branch 2 times, most recently from 18b4d97 to 81f2d3a Compare April 26, 2021 13:20
@davegomez
Copy link

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.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants