dwyl / alog

🌲 alog (Append-only Log) is an easy way to start using the Lambda/Kappa architecture in your Elixir/Phoenix Apps while still using PostgreSQL (with Ecto).
GNU General Public License v2.0
15 stars 2 forks source link

Documenting functions #34

Open RobStallion opened 5 years ago

RobStallion commented 5 years ago

Should we add documentation to private functions (despite the warning elixir gives because of this 🙄)?

I can't see the downside to this as it helps maintainers or people who wish to extend the application understand what these functions are doing.