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

doc: add IterableMap and IterableSet to store module glossary #1309

Conversation

TobieTom
Copy link

@TobieTom TobieTom commented Feb 15, 2025

Fixes #1283

Description

Adds missing documentation for IterableMap and IterableSet collections to the store module's glossary documentation.

Changes

  • Added IterableMap entry to Maps section explaining its performance characteristics and benefits
  • Added IterableSet entry to Sets section highlighting its optimized iteration capabilities
  • Maintained consistent documentation style with other collections

For more details, open the Copilot Workspace session.

Fixes near#1283

### Description
Adds missing documentation for `IterableMap` and `IterableSet` collections to the store module's glossary documentation.

### Changes
- Added `IterableMap` entry to Maps section explaining its performance characteristics and benefits
- Added `IterableSet` entry to Sets section highlighting its optimized iteration capabilities
- Maintained consistent documentation style with other collections

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/near/near-sdk-rs/issues/1283?shareId=XXXX-XXXX-XXXX-XXXX).
Copy link

codecov bot commented Feb 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.06%. Comparing base (1f3c071) to head (c8559d2).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1309      +/-   ##
==========================================
- Coverage   80.19%   80.06%   -0.14%     
==========================================
  Files         104      104              
  Lines       14856    14856              
==========================================
- Hits        11914    11894      -20     
- Misses       2942     2962      +20     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dj8yfo
Copy link
Collaborator

dj8yfo commented Feb 16, 2025

@TobieTom this is the right change to do.
It conflicts now with #1307 , which resolves this too.
I'll close this one.

Any pr should also have all ci passing, besides Add to dev tool project, which is fine to fail, and maybe codecov/patch, codecov/project, depending on the actual content in pr.
This had Test Core/Clippy & fmt job failing. Usually this should be fixed or at least commented on, why it's impossible to fix in context of pr, which may happen.

@dj8yfo dj8yfo closed this Feb 16, 2025
@dj8yfo
Copy link
Collaborator

dj8yfo commented Feb 16, 2025

@TobieTom you can leave a comment under #1300 or #1302 with a single attribute, that you want to work on, if it doesn't intersect with scope of #1307, i'll create a subtask for it (if there's none already), and assign you to it, so it's clearly visible this shouldn't be taken up by anybody else.
You did eventually submit a pr, so there's a moderate chance you will be up to creating another one.

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.

doc: missing mentions in glossary of rustdoc of IterableMap, IterableSet
2 participants