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

Use DocumenterCitations.jl for references #302

Merged
merged 29 commits into from
Aug 25, 2023
Merged

Use DocumenterCitations.jl for references #302

merged 29 commits into from
Aug 25, 2023

Conversation

kahaaga
Copy link
Member

@kahaaga kahaaga commented Aug 24, 2023

Fixes #301.

The docs are here.

  • Replaced all old-style footnote-style citations with refs.bib file.
  • Removed all manual citations from the text and replaced with @cite or @citet versions.
  • Added url/doi to all citation elements, where possible.
  • Checked typos in all citation elements.

Other changes

  • Export InformationMeasureEstimator. It is used in the devdocs.
  • Fixed a few errors in the doc examples.

@codecov
Copy link

codecov bot commented Aug 24, 2023

Codecov Report

Merging #302 (0c74d11) into main (231ae8c) will decrease coverage by 0.82%.
The diff coverage is n/a.

❗ Current head 0c74d11 differs from pull request most recent head 9fd002d. Consider uploading reports for the commit 9fd002d to get more accurate results

@@            Coverage Diff             @@
##             main     #302      +/-   ##
==========================================
- Coverage   87.22%   86.41%   -0.82%     
==========================================
  Files          75       72       -3     
  Lines        1848     1767      -81     
==========================================
- Hits         1612     1527      -85     
- Misses        236      240       +4     
Files Changed Coverage Δ
src/complexity_measures/approximate_entropy.jl 95.00% <ø> (ø)
src/complexity_measures/lempel_ziv.jl 100.00% <ø> (ø)
src/complexity_measures/missing_dispersion.jl 100.00% <ø> (ø)
.../complexity_measures/reverse_dispersion_entropy.jl 100.00% <ø> (ø)
src/complexity_measures/sample_entropy.jl 93.54% <ø> (ø)
src/complexity_measures/statistical_complexity.jl 100.00% <ø> (ø)
src/core/information_measures.jl 0.00% <ø> (ø)
...ferential_info_estimators/nearest_neighbors/Gao.jl 100.00% <ø> (ø)
...rential_info_estimators/nearest_neighbors/Goria.jl 100.00% <ø> (ø)
...estimators/nearest_neighbors/KozachenkoLeonenko.jl 100.00% <ø> (ø)
... and 43 more

... and 4 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@kahaaga kahaaga added the documentation Improvements or additions to documentation label Aug 24, 2023
@kahaaga kahaaga requested a review from Datseris August 25, 2023 08:19
@kahaaga kahaaga mentioned this pull request Aug 25, 2023
@Datseris
Copy link
Member

How does this PR interact with the ongoing #299 ? I am assuming there will be massive conflicts to resolve if either gets merged firstr.

Copy link
Member

@Datseris Datseris left a comment

Choose a reason for hiding this comment

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

this seems fine to me!

@kahaaga
Copy link
Member Author

kahaaga commented Aug 25, 2023

How does this PR interact with the ongoing #299 ? I am assuming there will be massive conflicts to resolve if either gets merged firstr.

There will be less work to resolve merge conflicts if #299 is merged first. I'll wait with merging this until that PR is done.

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

Successfully merging this pull request may close these issues.

Use DocumenterCitations.jl
2 participants