search

zackpi / lpc-serial

Implementing a Python serial programmer for LPC NXP devices
3 stars 0 forks source link

base lpc device documentation #1

Closed gregjhansell97 closed 6 years ago

gregjhansell97 commented 6 years ago

correct comments on all functions, currently copy pasta'd a template for every function

gregjhansell97 commented 6 years ago

when a function is done, leave a page number as a comment above pass

gregjhansell97 commented 6 years ago

here's the style guide I'm sort of following: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

gregjhansell97 commented 6 years ago

the reason for the style guide is we can then use Sphinx to auto build api documentation for us

zackpi commented 6 years ago

nice, I'll read up on it before making any new changes