Skip to content

Add missing docs#124

Open
ljedrz wants to merge 1 commit into
shepmaster:masterfrom
ljedrz:more_docs
Open

Add missing docs#124
ljedrz wants to merge 1 commit into
shepmaster:masterfrom
ljedrz:more_docs

Conversation

@ljedrz

@ljedrz ljedrz commented May 28, 2018

Copy link
Copy Markdown
Contributor

No description provided.

@shepmaster

Copy link
Copy Markdown
Owner

So... I deliberately left off a lot of these (not all) because they are pointless repetitions of the method name. Care to take a shot at convincing me what the value of this type of documentation adds?

/// An owned prefixed name.
struct OwnedPrefixedName

@ljedrz

ljedrz commented May 28, 2018

Copy link
Copy Markdown
Contributor Author

Docs like this aren't necessary, but potential crate users often evaluate crate quality based on the completeness of the documentation (I know I do when I don't recognize the crate's owner). Undocumented entries, especially in versions < 1.0 may come off as work in progress or feature-incomplete.

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.

2 participants