search

jazzband / geojson

Python bindings and utilities for GeoJSON
https://pypi.python.org/pypi/geojson/
BSD 3-Clause "New" or "Revised" License
918 stars 122 forks source link

Improve the documentation #6

Closed frewsxcv closed 11 years ago

frewsxcv commented 11 years ago

Right now the documentation is relatively unorganized and not entirely informative. Possible suggestions for improvement include conversion to markdown (for use on GitHub) or rst (for use on readthedocs). Additionally, a complete page documenting the API would greatly benefit new users. As per this comment I'd be willing to take this task

sgillies commented 11 years ago

I'll be happy to transfer ownership of sgillies/geojson to frewsxcv. Looks like you'll need to remove or rename your existing fork for me to transfer through the github web ui.

frewsxcv commented 11 years ago

Just renamed my repository temporarily. I'm working on the documentation upgrades locally for now. Let me know when you transfer it. Thanks again.

sgillies commented 11 years ago

Hmm, I'm getting this error when I try to transfer: "frewsxcv already has a repository in the sgillies/geojson network"

You may need to delete yours.

frewsxcv commented 11 years ago

Alright, it's deleted. I imagine it didn't like that I would have forked one of my own repositories.

sgillies commented 11 years ago

Well, that was fast :)

steko commented 11 years ago

FWIW, I favour rst over markdown (in this specific case). RTD integration would be nice. .rst files are shown as formatted HTML on GitHub, too (but the file extension must be .rst and not the common .txt).

frewsxcv commented 11 years ago

@sgillies Is it possible I could become the owner of the geojson project on PyPi? I plan to push a small update out by this weekend. My username on PyPi is frewsxcv.

sgillies commented 11 years ago

Good idea. What's your PyPI username?

frewsxcv commented 11 years ago

frewsxcv

sgillies commented 11 years ago

Done.