ash-project / ash

A declarative, extensible framework for building Elixir applications.
https://www.ash-hq.org
MIT License
1.64k stars 220 forks source link

don't document options helpers but add typespecs #1613

Closed allenwyma closed 4 days ago

allenwyma commented 5 days ago

Contributor checklist

zachdaniel commented 5 days ago

making them @doc false essentially declares them as private, so we should leave that change out.

allenwyma commented 5 days ago

making them @doc false essentially declares them as private, so we should leave that change out.

These seem quite specific for a reason and not really usable for most outside of those needing to use them. I was thinking for their specific use they don’t need to be documented.

if they aren’t doc false then I’d like to have some docs on them. I can try to add what I understand m them to be if you or someone else can touch them up after that’d be great.

zachdaniel commented 4 days ago

🚀 Thank you for your contribution! 🚀