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

Improve CartoDataFrame documentation #1307

Closed
3 tasks done
alasarr opened this issue Dec 3, 2019 · 3 comments · Fixed by #1316
Closed
3 tasks done

Improve CartoDataFrame documentation #1307

alasarr opened this issue Dec 3, 2019 · 3 comments · Fixed by #1316
Assignees

Comments

@alasarr
Copy link
Contributor

alasarr commented Dec 3, 2019

We need to improve the reference: https://carto.com/developers/cartoframes/reference/#heading-CartoDataFrame

  • Add example for to_carto

  • Description for set_geometry and set_geometry_from_xy

  • Remove from doc astype, merge, dissolve, explode

@elenatorro
Copy link
Contributor

Although this should be really easy to add, I did a quick test on develop branch and I got some sphinx errors when building the docs, they're really easy to solve cause they're related with the format (for example: Bullet list ends without a blank line; unexpected unindent.).

When testing it, please remember to run them locally to see if there's any format error and check the final result :) The instructions to run docs locally are here.

@Jesus89
Copy link
Member

Jesus89 commented Dec 4, 2019

Elena, can we mark somehow the functions to skip the doc generation for the Dev Center reference?

@elenatorro
Copy link
Contributor

elenatorro commented Dec 4, 2019

Sure! it should be done by using :exclude-members: method_name in the .rst input file.

There's an example in the cartodataframe.rst file where we're skipping the convert method.

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

Successfully merging a pull request may close this issue.

3 participants