Skip to content
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

Improve internal documentation #52

Open
Tracked by #30
rpj opened this issue Nov 6, 2022 · 0 comments
Open
Tracked by #30

Improve internal documentation #52

rpj opened this issue Nov 6, 2022 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@rpj
Copy link
Member

rpj commented Nov 6, 2022

Specifically I'm thinking of RedisInternal.cpp and most specifically about the helper TR* macros: they're critical to how that file is implemented (although that doesn't always need to be the case...) and are nearly completely opaque. At very least the parameters should be named well (not single letters!) and described, and the behavior of each detailed.
@rpj rpj added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Nov 6, 2022
@rpj rpj mentioned this issue Nov 6, 2022
Open
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rpj