numere-org / NumeRe

Framework for numerical computations, data analysis and visualisation
https://www.numere.org
GNU General Public License v3.0
18 stars 6 forks source link

Convert documentation files to UTF-8 #97

Closed numeredev closed 1 year ago

numeredev commented 1 year ago

DESCRIPTION

Is your change request related to a problem? Please describe. git does not seem to handle CP1252 that well and switches the encoding to UTF-8 on every application of a suggestion.

Describe the solution you'd like Documentation and language files should be encoded in UTF-8 and the internal logics shall support it.

Describe possible alternatives you've considered An alternative would be to have a script to always restore the encoding before merging any translation file PR (which is itself tedious)

Additional context Add any other context or screenshots about the feature request here.

(Do not write below this line)


DEVS' SECTION

ANALYSIS

Should not be too difficult, because that requires only to convert the UTF-8 encoded text with the documentation files to CP1252 internally or even only to switch the font encoding of the documentation browser to UTF-8. The more time consuming task is to convert the actual files. It might be needed to do that differently for the language files.

IMPLEMENTATION STEPS

(see also our Wiki for implementation guidelines)

DOCUMENTATION STEPS

(see also our Wiki for further information)

PULL REQUEST

numeredev commented 1 year ago

Tiny additional change would be to enable code highlighting for function and method documentations created by the doc_help() function.