Check private method docstrings for information that may be relevant in public docstrings

kostaleonard / great-model-theory

A deep learning library for Scala.

MIT License

2 stars 0 forks source link

Check private method docstrings for information that may be relevant in public docstrings #67

Open kostaleonard opened 1 year ago

kostaleonard commented 1 year ago

As a machine learning engineer, I want the public interfaces to contain all relevant docstring information so that I can use the interfaces correctly.

It's fine to have docstrings for private functions, but they should contain only implementation details irrelevant to users.