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.

Sign up for GitHub

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

Jump to bottom

Cleanup / Documentation #44

Open
2 of 5 tasks
pocketken opened this issue Sep 24, 2021 · 0 comments
Open
2 of 5 tasks

Cleanup / Documentation #44

pocketken opened this issue Sep 24, 2021 · 0 comments
Assignees
@pocketken
Labels
documentation Improvements or additions to documentation

Comments

@pocketken
Copy link
Owner

pocketken commented Sep 24, 2021 •
edited
Loading

Before the next release, need to:

  • clean up some of the duplication introduced in Reduce allocations / improve performance #43; in particular explore the idea of using Coordinate instead of GeoCoord for all the spherical coordinates
  • properly mark things internal / public -- right now pretty much everything is public, is that what we want?
  • add some API documentation + examples; the unit tests are ok but not great at providing a library overview and (more importantly) how upstream concepts are mapped/implemented in this port. A simple getting started doc with some generated API docs would go a long way
  • review the names and concepts RFC and figure out which are applicable
  • update benchmarks
@pocketken pocketken self-assigned this Sep 24, 2021
@pocketken pocketken added the documentation Improvements or additions to documentation label Sep 24, 2021
pocketken added a commit that referenced this issue Oct 24, 2021
@pocketken
GH-44: some basic docs
4a2b833
pocketken added a commit that referenced this issue Dec 16, 2021
@pocketken
Release 3.7.2.1 (#52)
4d39883 
  * GH-42: improve performance for polyfill + lines
  * GH-44: basic docs
  * GH-45: implement polyfill modes
  * GH-46: add support for netstandard2.1
  * GH-49: add support for netstandard2.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pocketken pocketken

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pocketken