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

Show module docstring for namespace indexes #3351

Conversation

Matthew-Mosior
Copy link
Contributor

@Matthew-Mosior Matthew-Mosior commented Jul 24, 2024

This PR addresses 3014 and adds functionality for adding docstrings for each applicable module when created via --mkdoc.

Closes #3014.

@Matthew-Mosior Matthew-Mosior changed the title Show module docstring for namespace indexes - Issue 3014 Show module docstring for namespace indexes Jul 24, 2024
@gallais gallais self-assigned this Jul 25, 2024
TODO: add a common.css for these shared parts?
@gallais
Copy link
Member

gallais commented Jul 25, 2024

I've got a few fixes, do you mind authorising pushes from Idris2 maintainers on this PR?

@Matthew-Mosior
Copy link
Contributor Author

I've got a few fixes, do you mind authorising pushes from Idris2 maintainers on this PR?

No problem, just allowed that!

@gallais gallais force-pushed the issue-3014-show-module-docstring-for-namespace-indexes branch 2 times, most recently from 0c2f765 to d25e6d9 Compare July 25, 2024 12:06
@gallais gallais force-pushed the issue-3014-show-module-docstring-for-namespace-indexes branch from d25e6d9 to 61535f7 Compare July 25, 2024 12:15
@gallais gallais merged commit 91d0eb3 into idris-lang:main Jul 25, 2024
4 of 5 checks passed
@gallais
Copy link
Member

gallais commented Jul 25, 2024

I've fixed as many linting issues as I could. If someone wants to figure out that

Expected complex :not() pseudo-class notation selector-not-notation

then PRs are welcome.

@gallais gallais added documentation Improvements or additions to documentation backend: html labels Jul 25, 2024
@Matthew-Mosior
Copy link
Contributor Author

@gallais I didn't realize there was linting run on the repo, my apologies

@gallais
Copy link
Member

gallais commented Jul 25, 2024

No worries, most of the linting issues were introduced by me :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend: html documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Show module docstring for namespace indexes
2 participants