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.

Sign up for GitHub

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

Jump to bottom

light edits #38

Merged
merged 2 commits into from
Aug 20, 2024
Merged

light edits #38

merged 2 commits into from
Aug 20, 2024

Conversation

jverzani
Copy link
Contributor

In reading over the excellent documentation I noticed a few typos.

@codecov Codecov
Copy link

codecov bot commented Aug 20, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.41%. Comparing base (19f0169) to head (4c1f447).
Report is 3 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master      #38   +/-   ##
=======================================
  Coverage   72.41%   72.41%           
=======================================
  Files          69       69           
  Lines        2411     2411           
=======================================
  Hits         1746     1746           
  Misses        665      665

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

davibarreira
davibarreira reviewed Aug 20, 2024
View reviewed changes
docs/src/tutorials/7_composite.md Outdated
paper "Dece: Decision explorer with counterfactual explanations for machine learning models"
(2020, heng, Furui and Ming, Yao and Qu, Huamin).
paper ["Dece: Decision explorer with counterfactual explanations for machine learning models"](
https://doi.org/10.48550/arXiv.2008.08353)
Copy link
Owner

Choose a reason for hiding this comment

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

This seems to be causing an error in the Documenter.

davibarreira
davibarreira reviewed Aug 20, 2024
View reviewed changes
Copy link
Owner

@davibarreira davibarreira left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks a lot for the review! I'm really glad for the thorough review of the documentation. Hopefully you find the package useful.

It seems that one of the changes caused an error in the Documenter.

@jverzani
Copy link
Contributor Author

I'll remove it. I had the link handy from looking up the paper, so thought it might be useful.

@davibarreira
Copy link
Owner

I'll remove it. I had the link handy from looking up the paper, so thought it might be useful.

Thanks! It would be nice to have the link, but it seems that Documenter.jl has some issue with external links. I tried figuring out how to fix it, but I found no solution yet.

If I find it, I can then update the docs again with the link. Once more, thanks for all the corrections! I really apprettiate it.

@davibarreira davibarreira merged commit 6f348d7 into davibarreira:master Aug 20, 2024
5 checks passed
@jverzani
Copy link
Contributor Author

Thanks so much for this package. I've been having fun learning it and really appreciate the tutorials you put together!

@jverzani jverzani deleted the doc_edits branch August 20, 2024 17:25
@davibarreira
Copy link
Owner

Great to have feedback. Let me know if you find problems or have any suggestions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@davibarreira davibarreira davibarreira approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jverzani @davibarreira