dlowe-net / local-time

Time manipulation library for Common Lisp
Other
102 stars 43 forks source link

More docstrings #103

Open digikar99 opened 3 years ago

digikar99 commented 3 years ago

Hi!

Would there be any interest in including more docstrings from the documentation? Besides being helpful to users, this also makes things on https://github.com/cl-library-docs/common-lisp-libraries/ more scaleable. (My current plan is to keep separate files for manually written prologue-files. These files would be appended by docstrings to create the final documentation files for user consumption - so this relies much on the existence of docstrings to be of good use.)

If this is okay, I'd be willing to do this over the next month and issue a PR. Some examples where there is much documentation but no docstrings include the symbols in the section on Timezones, examples provided under preprovided format constants, as also the adjust-timestamp macros.

digikar99 commented 3 years ago