-
Notifications
You must be signed in to change notification settings - Fork 12.9k
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
Include "length" in the documentation for Vec::len(), slice::len() etc. #37866
Comments
The problem with this is that it's generally bad to include this in the summary, as it's just repeating what's already been said. So I didn't do this on purpose. I'm not sure what exact text rustdoc searches though.... i'd be against putting this in the summary, but for putting it in the longer description |
We seem to be very inconsistent about what summaries to use for |
It doesn't need to be in the summary(?), it can be in the body of the doc. Searching for |
use the word 'length' in Vec::len's docs Fixes rust-lang#37866
use the word 'length' in Vec::len's docs Fixes rust-lang#37866
use the word 'length' in Vec::len's docs Fixes rust-lang#37866
use the word 'length' in Vec::len's docs Fixes rust-lang#37866
use the word 'length' in Vec::len's docs Fixes rust-lang#37866
use the word 'length' in Vec::len's docs Fixes rust-lang#37866
use the word 'length' in Vec::len's docs Fixes rust-lang#37866
This ensures that someone looking at the
Vec
documentation who searches for the word "length" to find the method which returns the length of the method will be able to find the method, and also explains the origin of the name if someone is unaware.I bring this up because one of my coworkers came to me asking for the name of the method, because they were having trouble finding it in the documentation.
The text was updated successfully, but these errors were encountered: