SatelCreative / spylib

A library to facilitate interfacing with Shopify's API
https://satelcreative.github.io/spylib
MIT License
3 stars 2 forks source link

👷 Add lazydocs validate to CI tests #186

Closed lishanl closed 1 year ago

lishanl commented 1 year ago
  1. Fix the following pydoc errors, close #145 :

    • D205: 1 blank line required between summary line and description (found 0)
    • D415: First line should end with a period, question mark, or exclamation point (not ',')
    • D200: One-line docstring should fit on one line with quotes (found 3)
    • D417: Missing argument descriptions in the docstring
    • D106: Missing docstring in public nested class
  2. Add lazydocs --validate spylib to CI tests

  3. Turn back on lazydocs --validate spylib to CD doc generate and deployment on releases

lishanl commented 1 year ago

the pydocstyle errors are addressed in this PR for lazydocs --validate however, there are import errors, config errors when generation the doc which should be addressed in another PR. image