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

clarify permutedims docs #52261

Merged
merged 8 commits into from
Dec 15, 2023
Merged

clarify permutedims docs #52261

merged 8 commits into from
Dec 15, 2023

Conversation

stevengj
Copy link
Member

As commented on discourse, it would be nice if the permutedims examples began with something like an array of strings where transpose is inapplicable.

This PR simply clarifies the docs and adds a few more examples.

@stevengj stevengj added domain:docs This change adds or pertains to documentation domain:arrays [a, r, r, a, y, s] labels Nov 21, 2023
base/permuteddimsarray.jl Outdated Show resolved Hide resolved
base/permuteddimsarray.jl Outdated Show resolved Hide resolved
stevengj and others added 3 commits November 21, 2023 17:13
Co-authored-by: Haakon Ludvig Langeland Ervik <[email protected]>
Co-authored-by: Haakon Ludvig Langeland Ervik <[email protected]>
base/permuteddimsarray.jl Outdated Show resolved Hide resolved
@stevengj
Copy link
Member Author

Pursuant to the discussion above, I merged the docstrings for permutedims(A::Array, perm) and permutedims(A::AbstractMatrix), since the latter is just a special case of the former with perm = (2,1).

@stevengj
Copy link
Member Author

Bump.

base/permuteddimsarray.jl Outdated Show resolved Hide resolved
Co-authored-by: Jishnu Bhattacharya <[email protected]>
base/permuteddimsarray.jl Outdated Show resolved Hide resolved
@jishnub
Copy link
Contributor

jishnub commented Dec 15, 2023

Looks good to me, and it's a clear improvement

@jishnub jishnub added status:merge me PR is reviewed. Merge when all tests are passing and removed status:merge me PR is reviewed. Merge when all tests are passing labels Dec 15, 2023
@jishnub jishnub merged commit 9fc1b65 into master Dec 15, 2023
9 checks passed
@jishnub jishnub deleted the stevengj-patch-7 branch December 15, 2023 06:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:arrays [a, r, r, a, y, s] domain:docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants