Skip to content
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

Merged
merged 1 commit into from
Sep 7, 2024

Conversation

Hoverth
Copy link
Contributor

@Hoverth Hoverth commented Sep 6, 2024

Fixes a number of issues so that the generated documentation (in amber-docs/#39) looks better and is more understandable.

Should fix #459.

@Mte90
Copy link
Member

Mte90 commented Sep 6, 2024

There is already a ticket for multiline comments #459

If we fix that a lot of issues in the documentation generated are solved.
Anyway this PR fixes various english issues already reported by @mks-h

@Hoverth
Copy link
Contributor Author

Hoverth commented Sep 6, 2024

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.

@Mte90
Copy link
Member

Mte90 commented Sep 6, 2024

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).
So we need a fix anyway in Amber

Copy link
Contributor Author

@Hoverth Hoverth left a 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

src/std/date.ab Show resolved Hide resolved
src/std/date.ab Show resolved Hide resolved
@Mte90 Mte90 changed the title doc: update docs with formatting, grammar and spelling fixes stdlib: update stdlib docs with formatting, grammar and spelling fixes Sep 6, 2024
src/std/date.ab Show resolved Hide resolved
Copy link
Member

@KrosFire KrosFire left a 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

@b1ek b1ek merged commit 99c9be2 into amber-lang:master Sep 7, 2024
1 check passed
@Hoverth Hoverth deleted the doc-overhaul branch September 8, 2024 03:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Documentation generated has issues with multiline comments
4 participants