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

426 add section on convergence to docs and improve docstrings #429

Merged

Conversation

pat-alt
Copy link
Member

@pat-alt pat-alt commented Apr 16, 2024

No description provided.

@pat-alt pat-alt linked an issue Apr 16, 2024 that may be closed by this pull request
Changelog.CommonMark(),
joinpath(@__DIR__, "..", "CHANGELOG.md");
repo="juliatrustworthyai/CounterfactualExplanations.jl",
)
Copy link
Contributor

Choose a reason for hiding this comment

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

[JuliaFormatter] reported by reviewdog 🐶

Suggested change
)
)

docs/make.jl Outdated
Comment on lines 87 to 88
repo="github.com/JuliaTrustworthyAI/CounterfactualExplanations.jl.git",
devbranch="main"
Copy link
Contributor

Choose a reason for hiding this comment

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

[JuliaFormatter] reported by reviewdog 🐶

Suggested change
repo="github.com/JuliaTrustworthyAI/CounterfactualExplanations.jl.git",
devbranch="main"
repo="github.com/JuliaTrustworthyAI/CounterfactualExplanations.jl.git", devbranch="main"


setup_docs = quote

Copy link
Contributor

Choose a reason for hiding this comment

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

[JuliaFormatter] reported by reviewdog 🐶

Suggested change

docs/doctest.jl Outdated
DocMeta.setdocmeta!(
CounterfactualExplanations, :DocTestSetup, :($setup_docs); recursive=true
)
doctest(CounterfactualExplanations)
Copy link
Contributor

Choose a reason for hiding this comment

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

[JuliaFormatter] reported by reviewdog 🐶

Suggested change
doctest(CounterfactualExplanations)
doctest(CounterfactualExplanations)

docs/make.jl Outdated
)

makedocs(;
doctest = false,
Copy link
Contributor

Choose a reason for hiding this comment

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

[JuliaFormatter] reported by reviewdog 🐶

Suggested change
doctest = false,
doctest=false,

@pat-alt pat-alt merged commit 871d0ae into main Apr 17, 2024
10 checks passed
@pat-alt pat-alt deleted the 426-add-section-on-convergence-to-docs-and-improve-docstrings branch April 17, 2024 12:32
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 this pull request may close these issues.

Add section on convergence to docs and improve docstrings
1 participant