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

Document bounded_vec #4348

Closed
Savio-Sou opened this issue Feb 12, 2024 · 0 comments · Fixed by #4430
Closed

Document bounded_vec #4348

Savio-Sou opened this issue Feb 12, 2024 · 0 comments · Fixed by #4430
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Savio-Sou
Copy link
Collaborator

Savio-Sou commented Feb 12, 2024

Corresponding PR: #4197

P.S. As v0.24.0 is pre-released, reminder to copy doc changes into version-v0.24.0 when making them.

@Savio-Sou Savio-Sou added the documentation Improvements or additions to documentation label Feb 12, 2024
@Savio-Sou Savio-Sou added this to the 0.24 milestone Feb 12, 2024
@kevaundray kevaundray assigned jfecher and unassigned kevaundray Feb 12, 2024
@jfecher jfecher mentioned this issue Feb 16, 2024
5 tasks
github-merge-queue bot pushed a commit that referenced this issue Feb 18, 2024
# Description

## Problem\*

Working towards #4348

## Summary\*

We'll soon have bounded vec and hashmap types documented so I thought
I'd create a new `containers` folder for documentation of the
`std::containers` module.

## Additional Context

Minor updates in the Vec docs:
- Removed implementation details from methods
- Reordered `Vec::len` up to the top since it is important
- Minor grammar fixes

## Documentation\*

Check one:
- [ ] No documentation needed.
- [x] Documentation included in this PR.
- [ ] **[Exceptional Case]** Documentation to be submitted in a separate
PR.

# PR Checklist\*

- [x] I have tested the changes locally.
- [x] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.

Co-authored-by: kevaundray <kevtheappdev@gmail.com>
github-merge-queue bot pushed a commit that referenced this issue Feb 28, 2024
# Description

## Problem\*

Resolves #4348

## Summary\*

Documents `BoundedVec`

## Additional Context



## Documentation\*

Check one:
- [ ] No documentation needed.
- [x] Documentation included in this PR.
- [ ] **[Exceptional Case]** Documentation to be submitted in a separate
PR.

# PR Checklist\*

- [x] I have tested the changes locally.
- [x] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.

---------

Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>
Co-authored-by: Tom French <tom@tomfren.ch>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants