Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Better display of props in documentation #984

Closed
sharynneazhar opened this issue Sep 27, 2018 · 1 comment
Closed

Better display of props in documentation #984

sharynneazhar opened this issue Sep 27, 2018 · 1 comment
Labels
docs help wanted

Comments

@sharynneazhar
Copy link
Contributor

The props in API references are hard to read.

screen shot 2018-09-27 at 3 45 37 pm

Can we update the docs so the props stand out more? E.g.

screen shot 2018-09-27 at 3 52 48 pm
@mcnuttandrew
Copy link
Contributor

This is a reasonable idea! I would certainly accept a PR that added the sorts of styling you examplify above

Wattenberger added a commit to Wattenberger/react-vis that referenced this issue Oct 7, 2018
@Wattenberger
Make props in documentation easier to parse (uber#984)
232f416
Wattenberger added a commit to Wattenberger/react-vis that referenced this issue Oct 7, 2018
@Wattenberger
Make props in documentation easier to parse (uber#984)
cdb825d
Wattenberger added a commit to Wattenberger/react-vis that referenced this issue Oct 7, 2018
@Wattenberger
docs - make header usage more consistent (h4/h5 for props) [uber#984]
2571bb0
mcnuttandrew pushed a commit that referenced this issue Oct 8, 2018
@Wattenberger @mcnuttandrew
Make props in documentation easier to parse (#984) (#993)
3558e50 
* Make props in documentation easier to parse (#984)

* docs - make header usage more consistent (h4/h5 for props) [#984]

* update doc props styles - change blue highlight to underline

and highlight code instead

* docs - make sure Type and Default declarations are individual paragraphs
ayarcohaila pushed a commit to ayarcohaila/react-vis that referenced this issue Jun 30, 2021
Make props in documentation easier to parse (uber#984) (uber#993)
97b3650 
* Make props in documentation easier to parse (uber#984)

* docs - make header usage more consistent (h4/h5 for props) [uber#984]

* update doc props styles - change blue highlight to underline

and highlight code instead

* docs - make sure Type and Default declarations are individual paragraphs
ayarcohaila added a commit to ayarcohaila/react-vis that referenced this issue May 30, 2023
@ayarcohaila
Make props in documentation easier to parse (uber#984) (uber#993)
b581b48 
* Make props in documentation easier to parse (uber#984)

* docs - make header usage more consistent (h4/h5 for props) [uber#984]

* update doc props styles - change blue highlight to underline

and highlight code instead

* docs - make sure Type and Default declarations are individual paragraphs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mcnuttandrew @sharynneazhar