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 core interfaces #497

Closed
tilk opened this issue Oct 30, 2023 · 1 comment
Closed

Document core interfaces #497

tilk opened this issue Oct 30, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@tilk
Copy link
Member

tilk commented Oct 30, 2023

The file layouts.py contains descriptions of the interfaces used in the core. They are important for understanding how the core as a whole works. They should be documented, using comments or docstrings (or both?).

@tilk tilk added the documentation Improvements or additions to documentation label Oct 30, 2023
@tilk
Copy link
Member Author

tilk commented Nov 18, 2023

Fixed by #501.

@tilk tilk closed this as completed Nov 18, 2023
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