Update sql.md #73
Update sql.md #73
Conversation
Hopefully making clear that an SQL database *requires* configuration away from the default RocksDB. Also, trying to make the language clearer, more succinct, and specific.
| ### Directory queries | ||
|
|
||
| In order to retrieve information about accounts, the following SQL directory queries need to be defined in the underlying [data store](/docs/storage/data): | ||
| In order to retrieve information about accounts, the following SQL directory queries must be defined in the underlying [data store](/docs/storage/data): |
There was a problem hiding this comment.
To me, a non native english speaker and sysadmin mostly familiar with technical documentation, is the "must" more clear as the "need to".
There was a problem hiding this comment.
I would say yes, it is clearer. Although to be honest, it may not be significantly different even to a native speaker.
Using a keyword like must is part of the language that standards bodies use. These words, like "MUST" and "MAY", disambiguate throughout documentation and technical description which can be extremely helpful for native and non-native speakers alike.
Without this explicit terminology I often find myself thinking, well, I may need to define the directory but maybe I can skip it if Stalwart has some code that automatically finds the directory? It helps me if things are spelled out clearly - if you don't do this it won't work.
2 participants
Hopefully making clear that an SQL database requires configuration away from the default RocksDB. Also, trying to make the language clearer, more succinct, and specific.