Make object model docstrings Sphinx/Napoleon compatible

leonhard-s / auraxium

A high-level Python wrapper for the PlanetSide 2 API.

https://auraxium.readthedocs.io/

MIT License

28 stars 8 forks source link

Make object model docstrings Sphinx/Napoleon compatible #19

Closed leonhard-s closed 4 years ago

leonhard-s commented 4 years ago

The object model docstrings are not using any cross-referencing yet, and they're also lacklustre regarding helpfulness to the user.

Conforming this documentation to the standard set for the other modules is a prerequisite to new users being able to use the object model effectively.

leonhard-s commented 4 years ago

Resolved as of aca6fc3.