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

some doc and deprecation fixes #17565

Merged
merged 1 commit into from
Jul 22, 2016
Merged

some doc and deprecation fixes #17565

merged 1 commit into from
Jul 22, 2016

Conversation

JeffBezanson
Copy link
Sponsor Member

Some stuff I came across when looking for undocumented stuff.

@stevengj I believe besselhx is also undocumented.

- minor fixes to DocCheck.jl, but it needs much more work
- add docs for isimag, clamp!, and isassigned
- fix deprecation for pmap keyword arguments

pmap(p, f, c...; kwargs...)
end
# deprecation warnings are in pmap.jl
Copy link
Contributor

Choose a reason for hiding this comment

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

this is going to be really easy to overlook

Copy link
Sponsor Member Author

Choose a reason for hiding this comment

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

Well, I tried. Unfortunately we simply don't have a way to deprecate a subset of keyword arguments using a separate definition.

Copy link
Contributor

Choose a reason for hiding this comment

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

so has the deprecation been broken in its current form?

Copy link
Sponsor Member Author

Choose a reason for hiding this comment

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

Yes, the deprecation did not work.

@stevengj
Copy link
Member

besselhx(nu,k,z) corresponds to the Amos zbesh function called with kode=2, i.e. it computes the scaled Hankel function exp((2k-3)*z*im) * besselh(nu, k, z) where k is 1 or 2.

@JeffBezanson JeffBezanson merged commit f578be3 into master Jul 22, 2016
@tkelman tkelman deleted the jb/docndepfixes branch July 23, 2016 01:52
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.

3 participants