search

PagerDuty / pdpyras

Low-level PagerDuty REST/Events API client for Python
MIT License
130 stars 30 forks source link

Fixed typo in example #8

Closed jade-pd closed 5 years ago

jade-pd commented 5 years ago

Whoops - realized the PR name isn't so descriptive. Fixed a typo in the example on the docs.

Deconstrained commented 5 years ago

Fixed upstream; note, the HTML is compiled from the restructured text (.rst) files and so they would be overwritten.

To fix the source and also the compiled documentation one can install Sphinx / GNU make (check to see if you already have it via whether which make prints out a path), and then:

  1. Fix the typo in the .rst file or docstrings
  2. Run make docs
  3. Stage and commit all changes to .rst files as well as the contents of the docs directory