This repository has been archived by the owner on Apr 3, 2019. It is now read-only.
fix(docs): better docs for the settings module #121
Merged
Conversation
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
philbooth
changed the title
philbooth
force-pushed
the
pb/settings-docs
branch
from
c9b487f
to
fe2403e
Compare
brizental
approved these changes
Jul 6, 2018
There was a problem hiding this comment.
This looks great, @philbooth . Thanks.
I will remember to document everything that I add to the codebase properly from now on :)
brizental
reviewed
Jul 6, 2018
| @@ -22,7 +22,8 @@ use validate; | |||
| mod test; | |||
|
|
|||
| macro_rules! deserialize_and_validate { | |||
| ($(($type:ident, $validator:ident, $expected:expr)),+) => ($( | |||
| ($(#[$docs:meta] ($type:ident, $validator:ident, $expected:expr)),+) => ($( | |||
| #[$docs] | |||
There was a problem hiding this comment.
Cool stuff, didn't know you had to do this in order to add comments.
There was a problem hiding this comment.
didn't know you had to do this in order to add comments
No worries, it took me a while to figure out how to do it! 😄
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
A couple of small documentation fixes, not associated with any issue:
Add a docstring to the
derive_and_validatemacro expansion. All the other types insettingshave a doc comment and the generated docs looked incomplete without it for these too.Fix up the docs for
SqsUrls, introducing a newline to keep the outer summary short and moving another note up from the wrong place where it was associated withSqsUrls::bounce.With these changes, the
settingsdocs look like this:@brizental, @mozilla/fxa-devs r?