-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
RFC: Cargo feature descriptions #3485
Open
tgross35
wants to merge
12
commits into
rust-lang:master
Choose a base branch
from
tgross35:feature-documentation
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
7aa7df0
Add initial feature-documentation RFC split from feature-metadata
tgross35 c52bd96
Update RFC number
tgross35 51400c5
Misc cleanup
epage 129ab25
Make it clear that a decision on markdown has not yet been reached
tgross35 326b4d9
Update text/3485-feature-documentation.md
tgross35 6a793f5
Update text/3485-feature-documentation.md
tgross35 4957dd0
Update text/3485-feature-documentation.md
tgross35 9cc3334
Update text/3485-feature-documentation.md
tgross35 9d87695
Update text/3485-feature-documentation.md
tgross35 b6d13a6
Add note about rustdoc support of links
tgross35 c330adb
Apply formatting
tgross35 b2b27a2
Add an example in the summary
tgross35 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Update text/3485-feature-documentation.md
Co-authored-by: Josh Triplett <josh@joshtriplett.org>
- Loading branch information
commit 326b4d961bec7e9128a67ea5c5d90ac2ef9f0a49
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Naming (not finding the past discussion on it)
doc
mirrors#[doc(...)]
description
mirrorspackage.description
documentation
mirrorspackage.documentation
(but that is a URL)We also tend to not use abbreviations as much. For example, for public-private dependencies, we discussed using
pub
vspublic
and went withpublic
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.
@epage In my opinion, I think this should be
doc
.I think we should encourage using this not just for a "description" of a feature but for "documentation" for a feature, and that's supported by the idea of it showing up in rustdoc and allowing markdown.
And I think there's a big difference in length between
doc
anddocumentation
, compared to the difference betweenpub
andpublic
. (I personally would have gone withpub
for that too, based on widespread usage ofpub
within Rust, but I also thinkpublic
was less obtrusive because it's fewer characters.)It's hard enough to get people to write documentation; let's not have any extra friction.
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.
Personally, I'd prefer we be consistent and not just focusing on character count.
We've shot well past that by requiring a "long form" just to write documentation, hurting both discoverability, character count, and ease of not typing some of those characters on international keyboards.