I recently hired into a data analytics team for a hospital, and we don’t have a style guide. Lots of frustration from folks working with legacy code…I thought putting together a style guide would help folks working with code they didn’t write, starting with requiring a header for SQL scripts first as low hanging fruit....
A header might be useful, although there’s likely better ways to (not) document what each sql statement does.
But inline documentation? I’d suggest trying to work around that. Here’s an explanation as to why: youtu.be/Bf7vDBBOBUA
If possible, and as much as possible, things should simply make enough sense to be self documenting. With only the high level concepts actually documented. Everything else is at risk to be outdated or worse, confuse
The Wikipedia definition seems to indicate it has origins as a racist term and I’ve never understood why unix users have adopted this terms instead of something benign like “themes” or “theming” which I remember being in use long before I ever heard “rice”. So what gives? Why use “rice” instead of “theme”?
No more code headers?
I recently hired into a data analytics team for a hospital, and we don’t have a style guide. Lots of frustration from folks working with legacy code…I thought putting together a style guide would help folks working with code they didn’t write, starting with requiring a header for SQL scripts first as low hanging fruit....
Do you consider the term "rice" or "ricer" to be racist?
The Wikipedia definition seems to indicate it has origins as a racist term and I’ve never understood why unix users have adopted this terms instead of something benign like “themes” or “theming” which I remember being in use long before I ever heard “rice”. So what gives? Why use “rice” instead of “theme”?