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

Add docstring to kernelkronmat and small corrections #377

Merged
merged 17 commits into from
Oct 20, 2021

Conversation

theogf
Copy link
Member

@theogf theogf commented Oct 6, 2021

Summary

  • Add docstring to kernelkronmat
  • Enforce stronger types for the inputs of kernelkronmat
  • Removed the unnecessary obsdim kwarg
  • Replace @assert statements by error
  • Use latex for iskroncompatible docstring
  • Rearrange the API docs (Conditional Utilities part)

Proposed changes
Following #369 I wanted to take care of moving kernelpdmat in the right place and add a docstring to kernelkronmat

What alternatives have you considered?
Deleting kernelkronmat

Breaking changes
I added stronger requirements on the kernelkronmat which might be considered breaking...

@theogf theogf changed the title Add doctring to `kernelkronmat Add docstring to kernelkronmat and small corrections Oct 6, 2021
src/matrix/kernelkroneckermat.jl Outdated Show resolved Hide resolved
src/matrix/kernelkroneckermat.jl Outdated Show resolved Hide resolved
theogf and others added 3 commits October 6, 2021 15:28
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Member

@Crown421 Crown421 left a comment

Choose a reason for hiding this comment

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

Not sure I am around long enough to approve PRs, but it does look good to me.

src/matrix/kernelkroneckermat.jl Outdated Show resolved Hide resolved
@theogf
Copy link
Member Author

theogf commented Oct 7, 2021

@willtebbutt @devmotion Given that I restricted the function signatures and removed a meaningless kwarg, should that be considered breaking?

@willtebbutt
Copy link
Member

My inclination is to say that this should not be considered breaking -- the restriction is probably a bug fix, and the meaningless kwarg feels like a bug. @devmotion what are your thoughts?

Copy link
Member

@devmotion devmotion left a comment

Choose a reason for hiding this comment

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

I'd consider it non-breaking.

src/matrix/kernelkroneckermat.jl Outdated Show resolved Hide resolved
src/matrix/kernelkroneckermat.jl Outdated Show resolved Hide resolved
src/matrix/kernelkroneckermat.jl Outdated Show resolved Hide resolved
src/matrix/kernelkroneckermat.jl Show resolved Hide resolved
src/matrix/kernelkroneckermat.jl Outdated Show resolved Hide resolved
src/matrix/kernelkroneckermat.jl Outdated Show resolved Hide resolved
theogf and others added 2 commits October 11, 2021 12:20
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@theogf theogf merged commit 7ce1c39 into master Oct 20, 2021
@theogf theogf deleted the tgf/docstring_kronmat branch October 20, 2021 14:51
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.

None yet

5 participants