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

Documentation for collections #1303

Open
YarinHeffes opened this issue Oct 11, 2024 · 0 comments
Open

Documentation for collections #1303

YarinHeffes opened this issue Oct 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers standard library

Comments

@YarinHeffes
Copy link
Collaborator

We should have a document with a table describing the collections provided in the standard library. This table should include the functionality provided for each collection, along with time complexity for basic operations such as lookup. It can also contain a brief description of the implementation of the collection and perhaps even an example use case for each collection to illustrate, for example, how one should choose between HashTable and Map. This table is important for new Coalton users to get started right away, but it will also highlight missing features of certain collections, serving as a good place for developers to reference to decide how to make the collections more uniform, what features to add, and potentially what collections to add.

@YarinHeffes YarinHeffes added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers standard library labels Oct 11, 2024
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 enhancement New feature or request good first issue Good for newcomers standard library
Projects
None yet
Development

No branches or pull requests

1 participant