Skip to content

Commit

Permalink
Merge pull request #79 from SciML/gd/docstring
Browse files Browse the repository at this point in the history 
Remove mention of SparseDiffTools in AbstractColoringAlgorithm
  • Loading branch information
@ChrisRackauckas
ChrisRackauckas authored Aug 9, 2024
2 parents 25600ca + d74073d commit c27ebd3
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ uuid = "47edcb42-4c32-4615-8424-f2b9edc5f35b"
authors = [
"Vaibhav Dixit <vaibhavyashdixit@gmail.com>, Guillaume Dalle and contributors",
]
version = "1.7.0"
version = "1.7.1"

[deps]
ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
Expand Down
8 changes: 2 additions & 6 deletions src/sparse.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ hessian_sparsity(f, x, ::NoSparsityDetector) = trues(length(x), length(x))
"""
AbstractColoringAlgorithm
Abstract supertype for Jacobian/Hessian coloring algorithms, defined for example in [SparseDiffTools.jl](https://github.com/JuliaDiff/SparseDiffTools.jl).
Abstract supertype for Jacobian/Hessian coloring algorithms.
# Required methods
Expand All @@ -59,11 +59,7 @@ Abstract supertype for Jacobian/Hessian coloring algorithms, defined for example
The terminology and definitions are taken from the following paper:
> "What Color Is Your Jacobian? Graph Coloring for Computing Derivatives"
>
> Assefaw Hadish Gebremedhin, Fredrik Manne, and Alex Pothen (2005)
>
> https://epubs.siam.org/doi/10.1137/S0036144504444711
> [_What Color Is Your Jacobian? Graph Coloring for Computing Derivatives_](https://epubs.siam.org/doi/10.1137/S0036144504444711), Assefaw Hadish Gebremedhin, Fredrik Manne, and Alex Pothen (2005)
"""
abstract type AbstractColoringAlgorithm end

Expand Down

2 comments on commit c27ebd3

@gdalle
Copy link
Collaborator

@gdalle gdalle commented on c27ebd3 Aug 9, 2024

Choose a reason for hiding this comment

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

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/112759

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.7.1 -m "<description of version>" c27ebd3e0367a3ac9759cebfa76a8f5fac5dc3a0
git push origin v1.7.1

Please sign in to comment.