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

Reorganize stdlib module exports for better doc generation #2172

Open
spotandjake opened this issue Oct 5, 2024 · 0 comments
Open

Reorganize stdlib module exports for better doc generation #2172

spotandjake opened this issue Oct 5, 2024 · 0 comments
Labels
good second issue Great issues if you're familiar with contributing to Grain. stdlib

Comments

@spotandjake
Copy link
Member

spotandjake commented Oct 5, 2024

As the stdlib modules have grown we have appended functions mostly just to the end of the files this isn't a major problem but as graindoc outputs documentation in order it can make the docs on the website a bit hard to navigate, it would probably make sense to go through our standard library modules and start by grouping related functions such as equality functions, operators and the likes, and then from there it would probably make sense to move more commonly used functions closer to the tops of the modules, this is not quite as straight forward as just ordering the modules though as functions with dependencies on other functions obviously have to come after, and we need to determine what the popular functions are.

Good second issue: The initial ordering so functions are grouped should be easy but it will probably require some discussion. I think we will need furthur discussion as a team about the generalized ordering and importance of functions.

@spotandjake spotandjake added stdlib good second issue Great issues if you're familiar with contributing to Grain. labels Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good second issue Great issues if you're familiar with contributing to Grain. stdlib
Projects
None yet
Development

No branches or pull requests

1 participant