matloff / matloff/partools

about naming

Open
#14 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
R
Stars
40
Forks
12
PR merge metrics
No merged PRs in 30d

Description

The points I raised here could be just personal taste, and it might be quite cumbersome to change names, but I think it's better discussed earlier than later.

I found some names in packages a little bit confusing:
- `ca` as core of `Software Alchemy`. I expected `sa` for this since chunk averaging is seldom mentioned. For averaging, isn't it possible sometimes we need something different, like getting max 10 values from all data? That's a typical Hadoop example, but `Software Alchemy` can handle it as well.
In the other hand, I find `Software Alchemy` itself didn't tell user what it is compare to `Divide and Combine`. Maybe you can also call it `scatter compute`.
- all function names don't have any way to separate words, either camel cases or underscore.
I have to mentally parse `filesplitrand`, the `r` inside it especially easy to be overlooked.
`calm` is difficult to be read as `ca lm`.
I'll suggest to use underscore, and use common prefix like `stringr`. So all functions will be like `file_xx`, `dis_`, `sa_xx`, or even just `f_xx`, `d_xx`.

Contributor guide

No contributing guide indexed for this repository

Research direction

No files, tests, or entry points are named. Start by reviewing the package and function names discussed in the issue, then determine whether the naming proposals have a settled scope and maintainer agreement; done would require an agreed naming plan rather than a single specified edit.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.