Skip to content

Commit

Permalink
Correct type signature in docstrings for Counts and Probabilities
Browse files Browse the repository at this point in the history
  • Loading branch information
kahaaga committed Jan 14, 2024
1 parent 2793ac8 commit 80202b9
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name = "ComplexityMeasures"
uuid = "ab4b797d-85ee-42ba-b621-05d793b346a2"
authors = "Kristian Agasøster Haaga <[email protected]>, George Datseries <[email protected]>"
repo = "https://github.com/juliadynamics/ComplexityMeasures.jl.git"
version = "3.1.0"
version = "3.1.1"

[deps]
Combinatorics = "861a8166-3701-5b0c-9a16-15d98fcdc6aa"
Expand Down
2 changes: 1 addition & 1 deletion src/core/counts.jl
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export is_counting_based
# use pre-normalized relative "frequencies", not counts, to estimate probabilities).
###########################################################################################
"""
Counts <: Array{N, <: Integer}
Counts <: Array{<:Integer, N}
Counts(counts [, outcomes [, outnames]]) → c
`Counts` stores an `N`-dimensional array of integer `counts` corresponding to a set of
Expand Down
2 changes: 1 addition & 1 deletion src/core/probabilities.jl
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export missing_outcomes
# Types
###########################################################################################
"""
Probabilities <: Array{N, <: AbstractFloat}
Probabilities <: Array{<:AbstractFloat, N}
Probabilities(counts/probs [, outcomes [, outnames]]) → p
`Probabilities` stores an `N`-dimensional array of probabilities, while ensuring that
Expand Down

2 comments on commit 80202b9

@kahaaga
Copy link
Member Author

Choose a reason for hiding this comment

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

@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/98852

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 v3.1.1 -m "<description of version>" 80202b9512e591f1e41fc977a1609fc401f8ca57
git push origin v3.1.1

Please sign in to comment.