Skip to content

Add small comment to each file about purpose #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
blaggacao opened this issue Sep 4, 2020 · 0 comments
Open

Add small comment to each file about purpose #62

blaggacao opened this issue Sep 4, 2020 · 0 comments

Comments

@blaggacao
Copy link
Contributor

blaggacao commented Sep 4, 2020 •
edited
Loading

Knowing pre-commit a fair bit, bit not beeing a nix expert, I found it extremely hard to reason about the structure and inner workings of this tool.

Traditional grep technics to identify callers and callees where not always successful.

Mostly, this might be attributed to the "black magic" — cum grano salis — of callPackage.

A small comment about the nature of each file at the top, would probably have helped me find my way around, better.

Related to #2 & #32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@blaggacao