language-servers/sway
1
0
Fork 0
mirror of https://github.com/FuelLabs/sway.git synced 2025-08-22 03:15:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Represent module level doc comments in forc doc (#4096)

Browse source 
## Description

Adds module level docs & previews to `forc doc`.

[Screencast from 2023-02-20
20-30-24.webm](https://user-images.githubusercontent.com/57543709/220232486-7ec0742a-59ef-41c9-a459-3c8c9b7d42c7.webm)


## Checklist

- [x] I have linked to any relevant issues. Closes #4095 
- [x] I have commented my code, particularly in hard-to-understand
areas.
- [x] I have updated the documentation where relevant (API docs, the
reference, and the Sway book).
- [x] I have added tests that prove my fix is effective or that my
feature works.
- [x] I have added (or requested a maintainer to add) the necessary
`Breaking*` or `New Feature` labels where relevant.
- [x] 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).
- [x] I have requested a review from the relevant team or maintainers.
This commit is contained in:
Chris O'Brien 2023-02-21 21:02:14 -06:00 • committed by GitHub
parent 5d2b10bd83
commit d9d5cb15a2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 131 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

1
sway-lib-std/src/lib.sw
View file

@ -1,3 +1,4 @@
//! The official standard library for the Sway smart contract language.
library std;
dep error_signals;