search

apache / druid

Apache Druid: a high performance real-time analytics database.
https://druid.apache.org/
Apache License 2.0
13.29k stars 3.66k forks source link

Enforce "dataSource" spelling via a Checkstyle regex #6870

Open leventov opened 5 years ago

leventov commented 5 years ago

Currently the codebase is a free mix of "datasource" and "dataSource" spelling.

gianm commented 5 years ago

The unwritten style rule I have been following is that in JSON and in code (method/variable names) the proper spelling is "dataSource" or "DataSource". But in natural language documentation, the proper spelling is "datasource", because writing dataSource or DataSource looks strange in the middle of natural language text.

If we were starting from scratch, I'd say call them "datasources" everywhere, but it'd be too disruptive to change all the JSON and code.

leventov commented 5 years ago

Good point. I thought that proper spelling in comments is "data source" (with a space), but now I'm not sure.

Maybe the scope of regex could be reduced to Java identifiers. (If not via Checkstyle, I'm pretty sure it's possible with IntelliJ structural search).

github-actions[bot] commented 11 months ago

This issue has been marked as stale due to 280 days of inactivity. It will be closed in 4 weeks if no further activity occurs. If this issue is still relevant, please simply write any comment. Even if closed, you can still revive the issue at any time or discuss it on the dev@druid.apache.org list. Thank you for your contributions.