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

Type specific impl blocks for the std-lib don't have generated docs #5957

Closed
bitzoic opened this issue May 3, 2024 · 0 comments · Fixed by #6017
Closed

Type specific impl blocks for the std-lib don't have generated docs #5957

bitzoic opened this issue May 3, 2024 · 0 comments · Fixed by #6017
Assignees
@sdankel
Labels
bug Something isn't working forc-doc Everything related to the `forc doc` command plugin.

Comments

@bitzoic
Copy link
Member

bitzoic commented May 3, 2024

For example, Identity has the variants listed, but none of the type specific implementations. Same for AssetId, traits implementations are shown but not something like AssetId::new()
@bitzoic bitzoic added bug Something isn't working forc-doc Everything related to the `forc doc` command plugin. labels May 3, 2024
@sdankel sdankel mentioned this issue May 8, 2024
Open
@sdankel sdankel self-assigned this May 14, 2024
@sdankel sdankel mentioned this issue May 15, 2024
Merged
8 tasks
sdankel added a commit that referenced this issue May 15, 2024
@sdankel @JoshuaBatty
feat: Add implementations to forc-doc (#6017)
d4f0c12 
## 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](https://github.com/FuelLabs/sway/assets/47993817/907f59c9-8555-4f0f-9ab2-353d4c17fa12)

## 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).
- [ ] If my change requires substantial documentation changes, I have
[requested support from the DevRel
team](https://github.com/FuelLabs/devrel-requests/issues/new/choose)
- [ ] 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](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [ ] I have requested a review from the relevant team or maintainers.

---------

Co-authored-by: Joshua Batty <joshpbatty@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sdankel sdankel

Labels
bug Something isn't working forc-doc Everything related to the `forc doc` command plugin.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Add implementations to forc-doc FuelLabs/sway
2 participants
@sdankel @bitzoic