search

DASSL / ClassDB

An open-source system to let students experiment with relational data
https://dassl.github.io/ClassDB/
Other
8 stars 2 forks source link

Function prologue comments are inconsistent (W) #133

Open smurthys opened 7 years ago

smurthys commented 7 years ago

Function prologue comments are a mix of tense and form. For example, here are the beginnings of three prologue comments in the script addUserMgmt.sql:

--List all connections for a specific user. Gets information from pg_stat_activity --Kills a specific connection given a pid INT4 --Define a function to create a user with the name and password supplied

It will be helpful if all prologue comments follow a consistent format/template.

smurthys commented 6 years ago

There is no need to explicitly address this issue for M2, but we all need to be mindful of comment structure and format with all new development.

Adding this comment so everyone gets notified of the need to be careful and observant.