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

Document utils and lib on the global farmOS namespace #402

Closed
jgaehring opened this issue Sep 2, 2020 · 1 comment
Closed

Document utils and lib on the global farmOS namespace #402

jgaehring opened this issue Sep 2, 2020 · 1 comment

Comments

@jgaehring
Copy link
Member

I believe a significant portion of the documentation will need to address the API for utils and lib on the global farmOS namespace.

They're basically what they say on the tin; utils contains some functions like parseNotes and mergeGeometries that are useful throughout the individual module components, while right now lib just includes the wellknown library for parsing WKT, but I'm also planning to include Ramda as soon as the need arises. It might also be good to add the Vue constructor and/or main instance, possibly Vuex as well.

The farmOS namespace also includes farmOS-map, although I'm not sure how to document that, since I'm intending the primary interface for maps to be the <farm-map> component instead.

I'm adding this to the 0.9.0 milestone, b/c it seems like that will be a good time to decide exactly what is needed and what isn't, when we're actually sprinting on new modules and should have a pretty good sense of that.

@jgaehring
Copy link
Member Author

Closing in favor of #492 and #493.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant