-
Notifications
You must be signed in to change notification settings - Fork 95
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
stdlib: update stdlib docs with formatting, grammar and spelling fixes #464
Conversation
I'm aware of the ticket, although in my opinion it's better for both to be done at once, as the lines already in the multi-line comment doesn't follow the typical tense for describing functions, so it makes sense to solve both at once. This should improve things for amber-lang/amber-docs#39 quite a bit. |
Yeah but if you see the date.ab file there are comments that still will be broken on rendering because they aren't in multiline (the part minute seconds etc). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not terribly sure what you mean, I tested all the files after i finished with them by using amber --doc $path
to make sure that the generated markdown files all were formatted correctly
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Good job
Fixes a number of issues so that the generated documentation (in amber-docs/#39) looks better and is more understandable.
Should fix #459.