Feat/docs prerelease#39
Merged
Merged
Conversation
added 2 commits
August 16, 2017 16:24
zamotany
suggested changes
Aug 16, 2017
| ``` | ||
| * `options?: Options` (optional) - same as `options` in `createMaterialPalette` function. | ||
|
|
||
| * `defaults?: PaletteDefaults` (optional) - Global defaults which will be propagated to each _connected_ component, alongside with palette instance, which will be used, if the specific color profile is not found: |
added 2 commits
August 16, 2017 16:27
added 2 commits
August 16, 2017 16:44
Contributor
Author
zamotany
suggested changes
Aug 16, 2017
| @@ -1,5 +1,107 @@ | |||
| # API | |||
|
|
|||
| ## `createMaterialPalette()` | |||
Contributor
There was a problem hiding this comment.
I would say to divide this doc into section as I did in withMaterialPalette to:
- example of usage
- description
- syntax
- flow types
- arguments
- more examples (this can be also concatenated with example of usage
Contributor
Author
There was a problem hiding this comment.
Sorry, but that's your personal opinion about structuring and it's already well structured. The API is thorough and complete. That section doesn't have to follow withMaterialPalette because you did it exactly that way. We don't have any convention in place. Again, this is the first release and I am putting all my effort to make it happen. We can always sit down later and elaborate a plan for structuring docs. So please guys, I am expecting more collaboration and flexibility on your side rather than pointing out every single detail, without enough justification.
satya164
approved these changes
Aug 17, 2017
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Closes #31