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

Update standard library and core library documentation to follow inline documentation standard #4812

Closed
52 tasks done
SwayStar123 opened this issue Jul 18, 2023 · 0 comments · Fixed by #4830
Closed
52 tasks done

Update standard library and core library documentation to follow inline documentation standard #4812

SwayStar123 opened this issue Jul 18, 2023 · 0 comments · Fixed by #4830
Assignees
@SwayStar123 @bitzoic
Labels
big this task is hard and will take a while documentation enhancement New feature or request lib: core Core library lib: std Standard library P: medium

Comments

@SwayStar123
Copy link
Member

SwayStar123 commented Jul 18, 2023 •
edited by bitzoic
Loading

Inline documentation standard can be seen here: https://github.com/FuelLabs/sway-standards/tree/master/standards/src_2

Core library:

  • never.sw
  • ops.sw
  • primitive_conversions.sw
  • primitives.sw
  • raw_ptr.sw
  • raw_slice.sw
  • storage.sw

Standard library:

  • storage/storable_slice.sw
  • storage/storage_api.sw
  • storage/storage_bytes.sw
  • storage/storage_key.sw
  • storage/storage_map.sw
  • storage/storage_string.sw
  • storage/storage_vec.sw
  • vm/evm/ecr.sw
  • vm/evm/evm_adress.sw
  • address.sw
  • alloc.sw
  • assert.sw
  • auth.sw
  • b256.sw
  • b512.sw
  • block.sw
  • bytes.sw
  • call_frames.sw
  • constants.sw
  • context.sw
  • contract_id.sw
  • convert.sw
  • ecr.sw
  • error_signals.sw
  • external.sw
  • flags.sw
  • hash.sw
  • identity.sw
  • inputs.sw
  • instrinsics.sw
  • logging.sw
  • low_level_call.sw
  • math.sw
  • message.sw
  • option.sw
  • outputs.sw
  • registers.sw
  • result.sw
  • revert.sw
  • string.sw
  • token.sw
  • tx.sw
  • u128.sw
  • u256.sw
  • vec.sw
@SwayStar123 SwayStar123 added enhancement New feature or request lib: std Standard library big this task is hard and will take a while lib: core Core library P: medium documentation labels Jul 18, 2023
@SwayStar123 SwayStar123 self-assigned this Jul 18, 2023
This was referenced Jul 18, 2023
Closed
Merged
@bitzoic bitzoic mentioned this issue Jul 19, 2023
Merged
7 tasks
bitzoic added a commit that referenced this issue Jul 20, 2023
@bitzoic
Update all storage inline docs to follow SRC-2 standard (#4836)
1b0f4c2 
## Description

Updating the storage inline docs to follow the new SRC-2 inline docs
standard. Note that this is being merged into the staging branch

Closes the following tasks of
#4812
storage/storable_slice.sw
 storage/storage_api.sw
 storage/storage_bytes.sw
 storage/storage_key.sw
 storage/storage_map.sw
 storage/storage_string.sw
 storage/storage_vec.sw

## Checklist

- [x] I have linked to any relevant issues.
- [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.

Co-authored-by: bitzoic <bitzoic.eth@gmail.com>
This was referenced Jul 20, 2023
Merged
Closed
Merged
Merged
bitzoic added a commit that referenced this issue Jul 22, 2023
@bitzoic
Update memory manipulation libs to meet SRC-2 inline docs standard (#…
7b8ca4b 
…4845)

## Description

Updated raw_ptr.sw, alloc.sw and raw_slice.sw closing out those tasks
for #4812

## Checklist

- [x] I have linked to any relevant issues.
- [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.

---------

Co-authored-by: bitzoic <bitzoic.eth@gmail.com>
bitzoic added a commit that referenced this issue Jul 22, 2023
@bitzoic
Update assertion and results to meet SRC-2 inline docs standard (#4846)
6520b42 
## Description

This PR completes the option.sw, result.sw, assert.sw, revert.sw, and
logging.sw tasks of #4812


## Checklist

- [x] I have linked to any relevant issues.
- [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.

---------

Co-authored-by: bitzoic <bitzoic.eth@gmail.com>
@bitzoic bitzoic mentioned this issue Jul 24, 2023
Merged
7 tasks
@bitzoic bitzoic self-assigned this Jul 25, 2023
This was referenced Jul 25, 2023
Merged
Merged
bitzoic added a commit that referenced this issue Jul 27, 2023
@bitzoic
Updates to storage docs to meet SRC-2 inline docs standard (#4864)
2dd2072 
## Description

It was noted that the most recent updates to the storage docs did not
include imports for examples. This has been added.

Documentation of the `StorageKey` type has also been included,
completing the storage.sw task of
#4812

## Checklist

- [x] I have linked to any relevant issues.
- [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.

---------

Co-authored-by: bitzoic <bitzoic.eth@gmail.com>
bitzoic added a commit that referenced this issue Jul 27, 2023
@bitzoic @JoshuaBatty
Update inline docs of address, contract id, and identity to meet SRC-…
2a4f6fb 
…2 standards (#4837)

## Description

Updated the `contract_id.sw`, `address.sw`, and `identity.sw` files to
meet the SRC-2 inline documentation standard.

This PR completes the following tasks of
#4812
 - address.sw
 - contract_id.sw
 - identity.sw
 
## Checklist

- [x] I have linked to any relevant issues.
- [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.

---------

Co-authored-by: bitzoic <bitzoic.eth@gmail.com>
Co-authored-by: JoshuaBatty <joshpbatty@gmail.com>
bitzoic added a commit that referenced this issue Jul 27, 2023
@bitzoic
Std-lib external, call_frames, and context inline docs updates to mee…
ad23dea 
…t SRC-2 standard (#4851)

## Description

This PR completes the external.sw, call_frames.sw, and context.sw tasks
of #4812

## Checklist

- [x] I have linked to any relevant issues.
- [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.

---------

Co-authored-by: bitzoic <bitzoic.eth@gmail.com>
@bitzoic bitzoic mentioned this issue Jul 28, 2023
Merged
7 tasks
bitzoic added a commit that referenced this issue Aug 5, 2023
@bitzoic
Update std-lib cryptographic functions to meet SRC-2 inline docs stan…
3462264 
…dard (#4863)

## Description

This PR completes the erc.sw, hash.sw, message.sw, evm/erc.sw, and
evm/evm_address.sw tasks of #4812

## Checklist

- [x] I have linked to any relevant issues.
- [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.

---------

Co-authored-by: bitzoic <bitzoic.eth@gmail.com>
bitzoic added a commit that referenced this issue Aug 5, 2023
@bitzoic
Update sway-lib-core to meet SRC-2 inline docs standard (#4882)
33f17e7 
## Description

This completes the never.sw, ops.sw, primitives.sw, and
primitive_conversions.sw tasks of
#4812

## Checklist

- [x] I have linked to any relevant issues.
- [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.

---------

Co-authored-by: bitzoic <bitzoic.eth@gmail.com>
@bitzoic bitzoic mentioned this issue Aug 5, 2023
Merged
7 tasks
bitzoic added a commit that referenced this issue Aug 7, 2023
@bitzoic
Update registers.sw to meet SRC-2 inline docs standard (#4920)
0bcc0f0 
## Description

This completes the registers.sw task of
#4812

## 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](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: bitzoic <bitzoic.eth@gmail.com>
JoshuaBatty added a commit that referenced this issue Aug 22, 2023
@SwayStar123 @bitzoic
@JoshuaBatty @K1-R1
Standard and core library inline documentation (#4830)
149b657 
## Description
Standardized documentation for the standard library and the core
library. Following the inline documentation standard (src-2)

Closes #4812

## Checklist

- [x] I have linked to any relevant issues.
- [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).
- [ ] 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.

---------

Co-authored-by: Cameron Carstens <54727135+bitzoic@users.noreply.github.com>
Co-authored-by: bitzoic <bitzoic.eth@gmail.com>
Co-authored-by: JoshuaBatty <joshpbatty@gmail.com>
Co-authored-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@SwayStar123 SwayStar123

@bitzoic bitzoic

Labels
big this task is hard and will take a while documentation enhancement New feature or request lib: core Core library lib: std Standard library P: medium
Projects
None yet
Milestone
No milestone
2 participants
@SwayStar123 @bitzoic