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

Add check for undocumented names; remove a dangling exported function #59

Merged
merged 2 commits into from
Nov 29, 2024

Conversation

pjaap
Copy link
Member

@pjaap pjaap commented Nov 28, 2024

No description provided.

@pjaap pjaap mentioned this pull request Nov 28, 2024
3 tasks
@pjaap
Copy link
Member Author

pjaap commented Nov 28, 2024

I'll fix the documentation problem

@pjaap
Copy link
Member Author

pjaap commented Nov 28, 2024

Hmm, CI complaines that GridVisualize.GridVisualize is not in the docs. That is true. But I wanted to use the README as documentation for this. Where do I put this in the docs?

@jpthiele
Copy link
Contributor

We could do an allindex.md similar to how VoronoiFVM does it https://wias-pdelib.github.io/VoronoiFVM.jl/stable/allindex/
inside the public api part of docs.

@j-fu
Copy link
Member

j-fu commented Nov 28, 2024

I always would put the module doc on top of docs/src/index.md

@jpthiele
Copy link
Contributor

I solved it in GridVisualizeTools like this WIAS-PDELib/GridVisualizeTools.jl@d94e632

@j-fu, did you check the resulting docs to see if you like how the result looks?

@j-fu
Copy link
Member

j-fu commented Nov 28, 2024

I checked the docs locally, it works.

@jpthiele
Copy link
Contributor

Good.
Can we remove the unrelated formatting commit from this PR? or move it to #57 ?

@j-fu
Copy link
Member

j-fu commented Nov 28, 2024

this is just the pluto notebook thing. I think it is not worth to bother that much about this. I would just keep it here, if you want to move it, it's ok as well.

@jpthiele jpthiele force-pushed the test/undocumentednames branch from a80cd72 to ff0bdbc Compare November 29, 2024 07:04
@jpthiele
Copy link
Contributor

I have removed the unrelated change to examples/plutovista.jl from 'update index.md' and with it the wrong format introduced therein.

@pjaap pjaap force-pushed the test/undocumentednames branch from ff0bdbc to a2f9782 Compare November 29, 2024 09:06
@pjaap
Copy link
Member Author

pjaap commented Nov 29, 2024

Should be good now

@pjaap pjaap merged commit a7b9c68 into main Nov 29, 2024
9 checks passed
@pjaap pjaap deleted the test/undocumentednames branch November 29, 2024 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants