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

Provide Architectural Documentation #19

Open
jackmoxley opened this issue Mar 21, 2021 · 0 comments
Open

Provide Architectural Documentation #19

jackmoxley opened this issue Mar 21, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@jackmoxley
Copy link
Contributor

It wasn't clear, neither from documentation nor from code and neither from automatic tests, what methods of access support the order-preserving iteration.
Consider also the explicit reordering, such as https://docs.rs/indexmap/1.6.1/indexmap/map/struct.IndexMap.html#method.sort_keys and https://docs.rs/indexmap/1.6.1/indexmap/map/struct.IndexMap.html#method.sort_by

The docs mention using HAMT and trie, but I couldn't verify it from a cursory look at the code. IMHO there should be a mapping between the high-level documentation, such as the mention of HAMT, and the relevant code. Imagine going to Google Maps, zooming in and seeing entirely different location. The lack of connection or mapping between the different layers of documentation is similarly disconcerting. In order to be reusable ( https://youtu.be/pW-SOdj4Kkk ) software needs to allow for gradual zooming in and our, from architectural overview to code and back, IMHO.

@jackmoxley jackmoxley added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 21, 2021
@jackmoxley jackmoxley removed the enhancement New feature or request label Apr 21, 2021
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
None yet
Development

No branches or pull requests

1 participant