l50 / goutils / 6461223011

88%

push

github

Doc gen mage (#404)

* Removed panic from test - non-idiomatic practice

* Fixed non-idiomatic practices

* Refine docgen: Update README templates for magefiles

- Omit Installation, Usage, and Tests sections specifically for `magefiles` README.
- Enhance function documentation with example usages and more concise structure.

* Clean up and refine documentation generation logic

- Removed redundant debugging and print statements from `docGeneration.go`.
- Improved and adjusted descriptions in magefiles' READMEs.
- Modified the template logic to better describe magefiles package.
- Condensed code by removing unnecessary comments and lines.

* Refactor TestCreatePackageDocs for DRYness and clarity

- Utilized helper functions `initBaseFs`, `initCommonDirs`, and `copyFilesToFs` to reduce redundancy in the setup of in-memory file systems for the test cases.
- Removed unused `printFs` function which was previously used for debugging purposes.
- Streamlined file copying process by using the `copyFilesToFs` function to reduce repetitive logic.

* Resolved formatting issues in the magefile comments

51 of 51 new or added lines in 1 file covered. (100.0%)

1339 of 2038 relevant lines covered (65.7%)

12.12 hits per line