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

Fix typo in docs #2030

Merged
merged 12 commits into from
Aug 1, 2022
Merged

Fix typo in docs #2030

merged 12 commits into from
Aug 1, 2022

Conversation

svilupp
Copy link
Contributor

@svilupp svilupp commented Jul 31, 2022

As part of the JuliaCon hackathon, I have fixed some typos I noticed in the docs and ran a few of the files through Grammarly.

There were no changes to the active code (only docs).

I'm happy to withdraw this PR if it's not helpful.

Copy link
Member

@ToucheSir ToucheSir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This is something I and others have wanted to do for a while but left as low priority, so it's great that you tackled it. I think the docs copy in general could use some wordsmithing, but that need not be addressed in this PR.

I've just taken the opportunity to touch up some existing grammatical awkwardness in the changed docs. If everything jives with you, we can merge.

src/optimise/train.jl Outdated Show resolved Hide resolved
docs/src/training/training.md Outdated Show resolved Hide resolved
docs/src/training/training.md Outdated Show resolved Hide resolved
docs/src/training/training.md Outdated Show resolved Hide resolved
docs/src/training/training.md Outdated Show resolved Hide resolved
docs/src/training/optimisers.md Outdated Show resolved Hide resolved
docs/src/training/optimisers.md Show resolved Hide resolved
@svilupp
Copy link
Contributor Author

svilupp commented Jul 31, 2022

Yes, absolutely - it looks much better!

I didn’t dare to change it too much, because different people have different styles and I didn’t want to step on any toes.

svilupp and others added 6 commits July 31, 2022 21:59
Co-authored-by: Brian Chen <ToucheSir@users.noreply.github.com>
Co-authored-by: Brian Chen <ToucheSir@users.noreply.github.com>
Co-authored-by: Brian Chen <ToucheSir@users.noreply.github.com>
Co-authored-by: Brian Chen <ToucheSir@users.noreply.github.com>
Co-authored-by: Brian Chen <ToucheSir@users.noreply.github.com>
Co-authored-by: Brian Chen <ToucheSir@users.noreply.github.com>
Copy link
Member

@mcabbott mcabbott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine to me, thanks!

@ToucheSir ToucheSir merged commit c4837f7 into FluxML:master Aug 1, 2022
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.

3 participants