Set minimum documentation level to internal #21

mdb1 · 2021-09-18T14:33:11Z

👋 Intro

Add swiftlint warning when something internal is not documented, in order to keep a high percentage of the codebase documented

Configured missing_docs rule to display warnings for internal things and errors for open and public
Changed generate_docs script to use internal as minimum documentation level in jazzy
Added missing documentation in the codebase
Ran generate_docs script

* 📝 Add a lot of missing documentation

mdb-danger-bot · 2021-09-18T14:38:38Z

	Warnings
⚠️	PR size seems relatively large. ✂️ If this PR contains multiple changes, please split each into separate PR will helps faster, easier review.

	Messages
📖	🎉 The PR added 26336 and removed 98 lines. 🗂 110 files changed.

Generated by 🚫 Danger Swift against aa4f373

mdb1 added 2 commits September 10, 2021 10:59

📝 Set Jazzy minimum level for docs to internal

4be9825

👮‍♀️ Add warning internal config for missing_docs swiftlint rule

aa4f373

* 📝 Add a lot of missing documentation

mdb1 added the documentation Improvements or additions to documentation label Sep 18, 2021

mdb1 self-assigned this Sep 18, 2021

mdb1 merged commit 9e8ffe0 into main Sep 18, 2021

mdb1 deleted the docs/document_internal branch September 18, 2021 15:47

mdb1 changed the title ~~Set minimum documentation to internal~~ Set minimum documentation level to internal Sep 18, 2021