Simon Willison’s Weblog

Subscribe

Thursday, 4th August 2022

Your documentation is complete when someone can use your module without ever having to look at its code. This is very important. This makes it possible for you to separate your module's documented interface from its internal implementation (guts). This is good because it means that you are free to change the module's internals as long as the interface remains the same.

Remember: the documentation, not the code, defines what a module does.

Ken Williams

# 3:50 pm / documentation

2022 » August

MTWTFSS
1234567
891011121314
15161718192021
22232425262728
293031