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

Write documentation #101

Closed
daanhb opened this issue Oct 6, 2021 · 5 comments
Closed

Write documentation #101

daanhb opened this issue Oct 6, 2021 · 5 comments

Comments

@daanhb
Copy link
Member

daanhb commented Oct 6, 2021

No description provided.

@zsunberg
Copy link
Contributor

Yes... there are many concepts in this package - it definitely deserves more documentation than is currently in the README.

For instance, rotations apparently exist in the source code, but are not mentioned in the docs.

@zsunberg
Copy link
Contributor

If someone sets up the documentation structure with Documenter.jl, I bet people would be happy to add to it incrementally. I may submit a PR for this if I get the chance.

@daanhb
Copy link
Member Author

daanhb commented Aug 21, 2022

For instance, rotations apparently exist in the source code, but are not mentioned in the docs.

This one is because I think rotations do not belong in this package :-) The plan is still to remove all functionality involving maps and put it into a separate package that can be developed independently (and possibly merged with one of the many other similar packages).

@daanhb
Copy link
Member Author

daanhb commented Sep 2, 2022

I gave setting up documenter.jl a try, but I'm missing something in the setup. Also, this is a dup of #8

@daanhb
Copy link
Member Author

daanhb commented Sep 2, 2022

It's live (but empty for now): https://JuliaApproximation.github.io/DomainSets.jl/dev

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

No branches or pull requests

2 participants