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

Is there a need for user-generated tutorials or example code? #228

Open
filipwodnicki opened this issue Nov 24, 2020 · 1 comment
Open
Labels

Comments

@filipwodnicki
Copy link

@martinfleis Love the library and I started playing with the code. I find the documentation to be thorough and the user guide to adequately cover conceptually what the library is about. That said, I'm wondering do you see a need for user-generated tutorials or example code?

This question came to mind as I was going from downloading OSM data to calculating areas and creating tessellations. I am able to piece together what to do just fine, but seeing the code sequentially rather than piecing it together would take away considerable part of the cognitive load of figuring out how to use momepy.

As a solution, I'm essentially writing a tutorial with sample code as I go through the functionality. I would be happy to contribute it to the repository or documentation.

Please see this notebook as a small sample of what I propose and let me know what you think.

Cheers
Filip

@martinfleis
Copy link
Member

Hi @filipwodnicki,

thanks for your words. I am more than happy to add Examples section to the documentation. There's always need for additional docs :).

If you can shortly describe each step you do in the notebook, we can directly plug it in the docs, ipynb gets automatically converted.

Looking forward to your contribution!

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

No branches or pull requests

2 participants