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.

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

Add left colored bars to API docs for distinct code objects like methods #735

Closed
Tracked by #479
Eric-Arellano opened this issue Jan 31, 2024 · 1 comment · Fixed by #1026
Closed
Tracked by #479

Add left colored bars to API docs for distinct code objects like methods #735

Eric-Arellano opened this issue Jan 31, 2024 · 1 comment · Fixed by #1026

Comments

@Eric-Arellano
Copy link
Collaborator

Eric-Arellano commented Jan 31, 2024

See Figma.

Attributes should be purple

Screenshot 2024-03-22 at 11 59 23

Methods and functions purple

Screenshot 2024-01-31 at 2 17 03 PM

Decide color for exceptions.

--

To implement this, we'll need to wrap each code object in a <div> with an appropriate class name set on it. Then the docs app will need to add styling for those classes. Adding <div> to the markdown will be interesting - an alternative approach could be to develop a proper MDX component.

@frankharkins
Copy link
Member

I vote for the MDX component as it might

  • allow for more semantic tags (e.g. parameters/returns/raises should be h4)
  • open up more interesting design possibilities such as indentation, having certain parts in a lighter font (like the old API docs), etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants