paulremo / NRPMHandbook

Repository to store and track the development on the ADS/Matrisk project for developing a jupyter book of the NRPM handbook.
Other
1 stars 1 forks source link

Terms and definitions capitalization #26

Closed paulremo closed 2 years ago

paulremo commented 2 years ago

The terms and definitions in the original handbook were capitalized (e.g., CONTRIBUTING FACTOR). This is problematic when references are generated to terms throughout the book automatically because capitalized terms have ugly plurals (e.g., CONTRIBUTING FACTORs).

The following things should be done:

Attention:

@csxADS: Be careful when automatically changing text in multiple documents. For example, failure models on this page was changed to FAILURE MODEls (mode is not a model)!

csxADS commented 2 years ago

@paulremo do I really need to change the capitalization inside terms.md ? That means I have to refactor each reference as well. It takes a very long time for not a big deal, isn't it ?

paulremo commented 2 years ago

Changing the capitalization inside terms.md should be really quick - and for the references in the rest of the document you can just do a (case-sensitive!) search and replace. That should be very quick, no?

csxADS commented 2 years ago

I'll do my best

paulremo commented 2 years ago

Great!