JuliaApproximation / DomainSets.jl

A Julia package for describing domains as continuous sets of elements
MIT License
72 stars 12 forks source link

Write documentation #101

Closed daanhb closed 5 months ago

zsunberg commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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

daanhb commented 2 years ago

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