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

feat: Add implementations to forc-doc #6017

Merged
merged 7 commits into from
May 15, 2024
Merged

feat: Add implementations to forc-doc #6017

merged 7 commits into from
May 15, 2024

Conversation

sdankel
Copy link
Member

@sdankel sdankel commented May 15, 2024

Description

Closes #5957

Also tweaked the CSS to make:

  • the subheaders inside of implementations smaller than the impl header
  • the colors a little less stark
  • the impl toggle blocks open by default (same as crates.io)

Discovered two issues, relating to enums and the sidebar, which I'll solve separately: #6018

image

Checklist

  • I have linked to any relevant issues.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
  • I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.

@sdankel sdankel marked this pull request as ready for review May 15, 2024 22:26
@sdankel sdankel requested a review from a team May 15, 2024 22:26
Copy link
Member

@kayagokalp kayagokalp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a single question to understand it better, great that we have this quickly!

forc-plugins/forc-doc/src/doc/mod.rs Show resolved Hide resolved
kayagokalp
kayagokalp previously approved these changes May 15, 2024
Copy link
Member

@kayagokalp kayagokalp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK 🚀

Copy link
Member

@JoshuaBatty JoshuaBatty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work Sophie! Thanks for whipping this up so quickly :)

@JoshuaBatty JoshuaBatty requested a review from kayagokalp May 15, 2024 23:01
@sdankel sdankel merged commit d4f0c12 into master May 15, 2024
37 checks passed
@sdankel sdankel deleted the sophie/forc-doc-impls branch May 15, 2024 23:23
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.

Type specific impl blocks for the std-lib don't have generated docs
3 participants