Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

typos #158

Closed
musvaage opened this issue Oct 2, 2024 · 2 comments · Fixed by #159
Closed

typos #158

musvaage opened this issue Oct 2, 2024 · 2 comments · Fixed by #159

Comments

@musvaage
Copy link
Contributor

musvaage commented Oct 2, 2024

dumped repo strings exposed a few typos

my version of doxygen is older than 1.9.4 which is listed in the current .html files

presumably were these fixes implemented

the DOC/html directory files would of consequence need to be regenerated

$ cat typos.sh
#!/bin/sh

sed -i "s/Compatiblitly/Compatibility/g" superlu/CMakeLists.txt
sed -i "s/Frotran/Fortran/g" superlu/FORTRAN/c_fortran_sgssv.c
sed -i "s/Frotran/Fortran/g" superlu/FORTRAN/c_fortran_dgssv.c
sed -i "s/Frotran/Fortran/g" superlu/FORTRAN/c_fortran_cgssv.c
sed -i "s/Frotran/Fortran/g" superlu/FORTRAN/c_fortran_zgssv.c
sed -i "s/Peforms/Performs/g" superlu/SRC/ilu_dpanel_dfs.c
sed -i "s/Peforms/Performs/g" superlu/SRC/ilu_zpanel_dfs.c
sed -i "s/Peforms/Performs/g" superlu/SRC/ilu_spanel_dfs.c
sed -i "s/Peforms/Performs/g" superlu/SRC/ilu_cpanel_dfs.c
sed -i "s/Peforms/Performs/g" superlu/SRC/spanel_dfs.c
sed -i "s/Peforms/Performs/g" superlu/SRC/dpanel_dfs.c
sed -i "s/Peforms/Performs/g" superlu/SRC/zpanel_dfs.c
sed -i "s/Peforms/Performs/g" superlu/SRC/cpanel_dfs.c
sed -i "s/TRANDPOSE/TRANSPOSE/g" superlu/SRC/clacon2.c
sed -i "s/TRANDPOSE/TRANSPOSE/g" superlu/SRC/zlacon2.c
sed -i "s/TRANDPOSE/TRANSPOSE/g" superlu/SRC/dlacon2.c
sed -i "s/TRANDPOSE/TRANSPOSE/g" superlu/SRC/slacon2.c
sed -i "s/avaliable/available/g" superlu/SRC/colamd.c
sed -i "s/defaut/default/g" superlu/SRC/mc64ad.c
sed -i "s/diagnal/diagonal/g" superlu/SRC/ilu_sdrop_row.c
sed -i "s/diagnal/diagonal/g" superlu/SRC/ilu_ddrop_row.c
sed -i "s/diagnal/diagonal/g" superlu/SRC/ilu_cdrop_row.c
sed -i "s/diagnal/diagonal/g" superlu/SRC/ilu_zdrop_row.c
sed -i "s/explaination/explanation/g" superlu/TESTING/MATGEN/zlaror.c
sed -i "s/explaination/explanation/g" superlu/TESTING/MATGEN/claror.c
sed -i "s/explict/explicit/g" superlu/MATLAB/hbo.m
sed -i "s/factorizaed/factorized/g" superlu/SRC/slu_util.h
sed -i "s/factorizaion/factorization/g" superlu/SRC/dgsisx.c
sed -i "s/factorizaion/factorization/g" superlu/SRC/sgsisx.c
sed -i "s/factorizaion/factorization/g" superlu/SRC/cgsisx.c
sed -i "s/factorizaion/factorization/g" superlu/SRC/zgsisx.c
sed -i "s/genrated/generated/g" superlu/.gitignore
sed -i "s/guarranteed/guaranteed/g" superlu/SRC/colamd.c
sed -i "s/incidate/indicate/g" superlu/TESTING/ddrive.c
sed -i "s/incidate/indicate/g" superlu/TESTING/cdrive.c
sed -i "s/incidate/indicate/g" superlu/TESTING/zdrive.c
sed -i "s/incidate/indicate/g" superlu/TESTING/sdrive.c
sed -i "s/indeces/indices/g" superlu/SRC/sreadrb.c
sed -i "s/indeces/indices/g" superlu/SRC/dgsitrf.c
sed -i "s/indeces/indices/g" superlu/SRC/dreadrb.c
sed -i "s/indeces/indices/g" superlu/SRC/cgsitrf.c
sed -i "s/indeces/indices/g" superlu/SRC/zreadrb.c
sed -i "s/indeces/indices/g" superlu/SRC/zgsitrf.c
sed -i "s/indeces/indices/g" superlu/SRC/sgsitrf.c
sed -i "s/indeces/indices/g" superlu/SRC/creadrb.c
sed -i "s/indended/intended/g" superlu/TESTING/MATGEN/zlarot.c
sed -i "s/indended/intended/g" superlu/TESTING/MATGEN/clarot.c
sed -i "s/indended/intended/g" superlu/TESTING/MATGEN/dlarot.c
sed -i "s/indended/intended/g" superlu/TESTING/MATGEN/slarot.c
sed -i "s/meanful/meaningful/g" superlu/SRC/supermatrix.h
sed -i "s/mimicing/mimicking/g" superlu/SRC/dgsitrf.c
sed -i "s/mimicing/mimicking/g" superlu/SRC/cgsitrf.c
sed -i "s/mimicing/mimicking/g" superlu/SRC/zgsitrf.c
sed -i "s/mimicing/mimicking/g" superlu/SRC/sgsitrf.c
sed -i "s/multipliation/multiplication/g" superlu/EXAMPLE/ditersol.c
sed -i "s/multipliation/multiplication/g" superlu/EXAMPLE/citersol.c
sed -i "s/multipliation/multiplication/g" superlu/EXAMPLE/sitersol.c
sed -i "s/multipliation/multiplication/g" superlu/EXAMPLE/zitersol1.c
sed -i "s/multipliation/multiplication/g" superlu/EXAMPLE/citersol1.c
sed -i "s/multipliation/multiplication/g" superlu/EXAMPLE/ditersol1.c
sed -i "s/multipliation/multiplication/g" superlu/EXAMPLE/zitersol.c
sed -i "s/multipliation/multiplication/g" superlu/EXAMPLE/sitersol1.c
sed -i "s/nessasary/necessary/g" superlu/SRC/colamd.c
sed -i "s/numercial/numerical/g" superlu/SRC/slu_cdefs.h
sed -i "s/numercial/numerical/g" superlu/SRC/slu_sdefs.h
sed -i "s/numercial/numerical/g" superlu/SRC/slu_ddefs.h
sed -i "s/numercial/numerical/g" superlu/SRC/slu_zdefs.h
sed -i "s/optinal/optional/g" superlu/TESTING/CMakeLists.txt
sed -i "s/orginal/original/g" superlu/SRC/dgsisx.c
sed -i "s/orginal/original/g" superlu/SRC/sgsisx.c
sed -i "s/orginal/original/g" superlu/SRC/cgsisx.c
sed -i "s/orginal/original/g" superlu/SRC/zgsisx.c
sed -i "s/preconditionning/preconditioning/g" superlu/EXAMPLE/cfgmr.c
sed -i "s/preconditionning/preconditioning/g" superlu/EXAMPLE/zfgmr.c
sed -i "s/preconditionning/preconditioning/g" superlu/EXAMPLE/sfgmr.c
sed -i "s/preconditionning/preconditioning/g" superlu/EXAMPLE/dfgmr.c
sed -i "s/provded/provided/g" superlu/EXAMPLE/README
sed -i "s/schimdt/schmidt/g" superlu/EXAMPLE/cfgmr.c
sed -i "s/schimdt/schmidt/g" superlu/EXAMPLE/zfgmr.c
sed -i "s/schimdt/schmidt/g" superlu/EXAMPLE/sfgmr.c
sed -i "s/schimdt/schmidt/g" superlu/EXAMPLE/dfgmr.c
sed -i "s/subtee/subtree/g" superlu/SRC/sp_coletree.c
sed -i "s/symmetrix/symmetric/g" superlu/SRC/colamd.c
$ 

https://github.com/scipy/scipy

someone took up the unproductive task of typo corrections of the bundled code over in SciPy

@musvaage
Copy link
Contributor Author

musvaage commented Oct 8, 2024

Would the Mantainers be interested in me opening a PR on this?

@gruenich
Copy link
Contributor

Sure give it a try. I cannot promise that it will be merged. My experience it, that Sherry accepts such small improvements.

You do not need to regenerate the document with Doxygen. It is done from time to time, not with every commit but prior to every release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants