search

gicait / geoserver-rest

Python library for management of geospatial data in GeoServer.
https://geoserver-rest.readthedocs.io
MIT License
191 stars 77 forks source link

ai-based doc cleanup #155

Closed iboates closed 1 month ago

iboates commented 1 month ago

Closes https://github.com/gicait/geoserver-rest/issues/46

This PR is actually very AI-heavy. I used ChatGPT to tidy up the existing docstrings and create ones where they were missing. I validated them afterwards and I found no problems. Despite this, I put a disclaimer on the API docs page because I believe that AI-generated contributions and content should always be disclosed.

Incidentally, the api docs page is currently broken. I built the docs locally and they seem to work now:

image

iboates commented 1 month ago

Hi @iboates, Thanks for this PR. Overall it looks good. I suggest to somehow include the notes part in the code. If the note section is raising some issue, I suggest to move it up, in the starting section of the docstring.

Apart from that, it looks good to me.

Sure, I also noticed that some of the nice organizational headers were removed by the almighty wise and all-knowing AI, I will put them back as well

iboates commented 1 month ago

@iamtekson Restored the notes and other comments

iboates commented 1 month ago

@iamtekson Do you have any more input? Or can I merge?