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

cdhc lib: add statlib cdh fortran code to lib docs #2642

Merged
merged 4 commits into from
Jan 5, 2024

Conversation

nilason
Copy link
Contributor

@nilason nilason commented Nov 10, 2022

This PR aim to add the Fortran source code, which was a base for cdhc library, for documentation purposes in the form of a Markdown file.

This is the source the library's author Darrell McCauley mention in "Goodness of Fit Tests" (lib/cdhc/docs/goodness.pdf):

Each function in the library returns a pointer to static double. The cdhc library was inspired by Johnson’s STATLIB collection of FORTRAN routines for testing distribution assumptions [22]. Some functions in cdhc are loosely based on Johnson’s work (they have been completely rewritten, reducing memory requirements and number of computations and fixing a few bugs). Others are based on algorithms found in Applied Statistics, Technometrics, and other related journals.

Limited amount of documentation remains, links mentioned in https://lists.osgeo.org/pipermail/grass-user/1995-July/023710.html are no longer available, thus this addition might be of help in the future.

@neteler
Copy link
Member

neteler commented Nov 10, 2022

(hint: to see this PR rendered in Markdown, see

Tab "Files changed" > three-dots menu on the right > View file

which is currently this:
https://github.com/OSGeo/grass/blob/f511591b948c1e0731156ad62a19ec1267623827/lib/cdhc/doc/chd_statlib.md)

@neteler neteler added manual Documentation related issues C Related code is in C and removed C Related code is in C labels Nov 10, 2022
@neteler neteler added this to the 8.3.0 milestone Nov 10, 2022
@wenzeslaus wenzeslaus modified the milestones: 8.3.0, 8.4.0 Feb 10, 2023
Copy link
Member

@echoix echoix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks ok to me, it’s a doc-only change, and is justified to be here for posterity.

@neteler
Copy link
Member

neteler commented Jan 5, 2024

it’s a doc-only change

In this case, with only a markdown file change, I would expect all CI build jobs being skipped. But indeed they all run (effectively not generating any insights):

image

I ask because of the meanwhile closed issue #2174.

@echoix echoix merged commit d2858c8 into OSGeo:main Jan 5, 2024
20 checks passed
@nilason nilason deleted the cdhc_add_fortran branch January 5, 2024 09:25
@nilason
Copy link
Contributor Author

nilason commented Jan 5, 2024

it’s a doc-only change

In this case, with only a markdown file change, I would expect all CI build jobs being skipped. But indeed they all run (effectively not generating any insights):

I ask because of the meanwhile closed issue #2174.

Technically adding [skip ci] to commit description work by default on GH to avoid CI checks. The rebase commit message ("Merge branch 'main' into cdhc_add_fortran") didn't contain that tag. For that to work now it had to be eg. "Merge branch 'main' into cdhc_add_fortran [skip ci]".

@echoix
Copy link
Member

echoix commented Jan 5, 2024

We have some checks that apply to markdown, docs and more, so it still makes sense to have some run.

HuidaeCho pushed a commit to HuidaeCho/grass that referenced this pull request Jan 9, 2024
* cdhc lib: add statlib cdh fortran code to lib docs

* lint

---------

Co-authored-by: Edouard Choinière <27212526+echoix@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
libraries manual Documentation related issues Markdown
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants