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

Document response fields via data model attributes #188

Closed
JWCook opened this issue Jun 27, 2021 · 1 comment · Fixed by #190, #194, #195 or #199
Closed

Document response fields via data model attributes #188

JWCook opened this issue Jun 27, 2021 · 1 comment · Fixed by #190, #194, #195 or #199
Labels
docs Documentation-related issues
Milestone

Comments

@JWCook
Copy link
Member

JWCook commented Jun 27, 2021

The data models (#145) and related features (#160 #174 #162) are mostly complete, but they could use more documentation:

  • Model attributes - these descriptions will then show up in the Sphinx docs
    • With Sphinx we can do 'doc comments' (#: comment above or inline)
    • Adding descriptions to attr.field metadata might be better, though
  • For each model, document all the API endpoints it can handle
  • more examples
@JWCook JWCook added the enhancement New feature or request label Jun 27, 2021
@JWCook JWCook added this to the v0.14 milestone Jun 27, 2021
@JWCook JWCook changed the title Data model testing & documentation Document response fields via data model attributes Jun 28, 2021
@JWCook JWCook added docs Documentation-related issues and removed enhancement New feature or request labels Jun 28, 2021
@JWCook JWCook linked a pull request Jun 28, 2021 that will close this issue
@JWCook JWCook linked a pull request Jul 2, 2021 that will close this issue
@JWCook
Copy link
Member Author

JWCook commented Jul 3, 2021

This is mostly done, but still a work in progress

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation-related issues
Projects
None yet
1 participant