JacquesCarette / Drasil

Generate all the things (focusing on research software)
https://jacquescarette.github.io/Drasil
BSD 2-Clause "Simplified" License
141 stars 26 forks source link

Remove unnecessary 'the' from purpose of Documents #3491

Closed janim2-2004 closed 1 year ago

janim2-2004 commented 1 year ago

As mentioned in #3317. In the Purpose of Documents in the Introduction, the first sentence goes as follows:

The primary purpose of this document is to record the requirements of the GlassBR

where GlassBR is replaced by the respective title of the SRS.

The the in requirements of the GlassBR should be removed.

smiths commented 1 year ago

Sounds good @ManvendraJani. I have one minor clarification, GlassBR is the name of the software, not the SRS. :smile:

janim2-2004 commented 1 year ago

Moving the discussion from #3505 to here @JacquesCarette @samm82. As mentioned by @samm82, I like the Idea of appending Program/Library instead of removing the 'the' but we run into issues where projectile can be either, a Program and a Library (depending on the choices). I believe we should still just remove the 'the' and also fix the progNames. Currently, titelize does not work on them, this would need to be fixed along with inconsistent naming (Projectile vs. Game Physics Library: why is there Library in the name?).

samm82 commented 1 year ago

Hmm... I think nailing down program names might be a good item to add to a meeting agenda; I personally see how the full name of "GamePhysics" could be "(the?) Game Physics Library", in which case "GamePhysics" is an abbreviation. I know we previously decided against including "the" in definitions (https://github.com/JacquesCarette/Drasil/issues/3234), but I think we could consider adding it to the full name of the program. This would mean that the entry in the table would be "the Game Physics Library", and using it in a sentence would be something like "the program documented here is the Game Physics Library". Doing so would mean that rendering this same sentence with Projectile would lead to "the program documented here is Projectile", so both "categories" of program names get rendered correctly

JacquesCarette commented 1 year ago

Note that the should not be in the name. the is a grammatical marker that indicates uniqueness (otherwise we'd use a). It actually has formal mathematical content!!!

When should add a the when we refer to an entity that we know is unique.