Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: Merging duplicate array broadcasting docs #19136

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.

Sign up for GitHub

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

Jump to bottom
Closed
4 tasks done
Mukulikaa opened this issue May 30, 2021 · 3 comments · Fixed by #19369
Closed
4 tasks done

DOC: Merging duplicate array broadcasting docs #19136

Mukulikaa opened this issue May 30, 2021 · 3 comments · Fixed by #19369
Labels
04 - Documentation

Comments

@Mukulikaa
Copy link
Contributor

Mukulikaa commented May 30, 2021 •
edited
Loading

@melissawm pointed out that Broadcasting and Array Broadcasting in Numpy contain a lot of duplicate content. Array Broadcasting in Numpy is also an orphan doc(not in any TOC) and is referenced in only one other place (Tutorial: Linear algebra on n-dimensional arrays).

I think we can merge the unique parts of the orphan doc into the main Broadcasting doc. The plan would be to:

  • Add Vector quantization section and update internal links
  • Add SVGs in Broadcasting for examples and Vector quantization section (ref: Tracking Issue for Graphics)
  • Add corresponding captions/explanations and alt-text for each figure
  • Remove the corresponding images from the directory

Figures 1 and 5 from Array Broadcasting in Numpy can be recycled and converted to SVGs, I think (please let me know what you think @MarsBarLee).
Figures 2, 3, 4 seem to be wrong... So I think we can make new graphics for the corresponding examples.

@melissawm please let me know if you have any suggestions/corrections!
@melissawm
Copy link
Member

Thanks, @Mukulikaa !

I agree that some of the content in the "Array broadcasting in NumPy" can be brought to the main "Broadcasting" page. But some of it definitely reads like a tutorial - might be worth thinking about reformatting that. But this could definitely be a second step once we decide on the basic plan.

One thing to be aware of is potential links to the orphan doc (such as the one found in the SVD Tutorial). Other pages might cite it so we may want to keep some kind of trail to the new doc.

@MarsBarLee
Copy link
Contributor

@Mukulikaa If we do go forward with recycling the chosen diagrams, I can certainly convert them!

We can also expand on 'Add corresponding captions/explanations for each figure' to include 'alt-text' (here are some examples of alt-text for graphs). Alt-text is one of the things we're looking at to make the NumPy docs and website more accessible. I have written some guidelines up specifically for NumPy that will be up soon, so once I have that up I can provide more help in that area.

@Mukulikaa
Copy link
Contributor Author

Alt-text is one of the things we're looking at to make the NumPy docs and website more accessible.

That's a great idea!

@Mukulikaa Mukulikaa mentioned this issue Jun 28, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
04 - Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: Moved VQ example & target from duplicate array broadcasting doc Mukulikaa/numpy
3 participants
@melissawm @MarsBarLee @Mukulikaa