search

blockwise-direct-search / bds_matlab

Blockwise Direct Search (MATLAB version)
GNU General Public License v3.0
1 stars 1 forks source link

Correct the English in your comments! #10

Closed zaikunzhang closed 1 year ago

zaikunzhang commented 1 year ago
  1. "Precondition" in the following line should be "Preconditions".

https://github.com/blockwise-direct-search/bds/blob/ced8cea6d68226f5d0ee1c997a15537e7c1269bf/src/blockwise_direct_search.m#L47

  1. What is "pre-conditions"? Why ignore the obvious inconsistency? It should be "preconditions".

  2. What does it mean to "operate" the preconditions? It should be "verify" or "check".

  3. conditionS IS?

See https://en.wikipedia.org/wiki/Design_by_contract .

Please, find someone to check each and every sentence of your comments. Make sure that the English is correct. Thank you very much.

Lht97 commented 1 year ago

I have corrected the comments on verify_preconditions and verify_postconditions.