Skip to content

Updates on "how to write documentation" #38

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.

Sign up for GitHub

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

Jump to bottom
Merged
yaahc merged 2 commits into from
Jun 2, 2022
Merged

Updates on "how to write documentation" #38

yaahc merged 2 commits into from
Jun 2, 2022

Conversation

@GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Jun 1, 2022

Some updates based on @m-ou-se comments in #35.

@BurntSushi
Copy link
Member

BurntSushi commented Jun 2, 2022

I think this still misses a few things? Contractions, whether Vec<String> should be two distinct links, # Example vs # Examples and some other things.

I noticed this because I was reviewing the changes as well and I believe I agreed with all of @m-ou-se's suggestions. Especially about the contractions. We should be allowed to use contractions.

@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Jun 2, 2022

The PR doesn't cover everything as I think the debate isn't finished yet. We should maybe bring it up on zulip so more people can comment too. Not sure what's the best course of action here...

@yaahc
Copy link
Member

yaahc commented Jun 2, 2022

The PR doesn't cover everything as I think the debate isn't finished yet. We should maybe bring it up on zulip so more people can comment too. Not sure what's the best course of action here...

Probably best to back out the controversial changes while discussion is ongoing to prevent confusion.

@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Jun 2, 2022

Good point! Updating the PR soon.

@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Jun 2, 2022

I removed the controversial parts.

@yaahc yaahc merged commit 0cb9115 into rust-lang:master Jun 2, 2022
github-actions bot pushed a commit that referenced this pull request Jun 2, 2022
publish: Merge pull request #38 from GuillaumeGomez/how-to-write-docs
1b56a24 
generated from commit 0cb9115
@GuillaumeGomez GuillaumeGomez deleted the how-to-write-docs branch June 2, 2022 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@GuillaumeGomez @BurntSushi @yaahc