The Wayback Machine - https://web.archive.org/web/20201103164451/https://github.com/numpy/numpy/issues/17517
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

DOC: ENH: I/O how-to needs a visual aid #17517

Open
bjnath opened this issue Oct 9, 2020 · 3 comments · May be fixed by #17556
Open

DOC: ENH: I/O how-to needs a visual aid #17517

bjnath opened this issue Oct 9, 2020 · 3 comments · May be fixed by #17556

Comments

@bjnath
Copy link
Contributor

@bjnath bjnath commented Oct 9, 2020

Improve navigation of the I/O how-to by prepending a decision tree/flowchart using an image or graphviz, as suggested by @mattip.

@TAnhMinh
Copy link

@TAnhMinh TAnhMinh commented Oct 13, 2020

Hi! I have created a "decision tree" but this is also my first issue so I am not sure how/where should I add it. Can I just add it to numpy/doc/source/reference/figures/ ? Thank you for your answer.

@mattip
Copy link
Member

@mattip mattip commented Oct 13, 2020

You could put it next to the howto itself in doc/source/user and reference it with .. image:: filename

It would be great if you could add a complete guide how you generated it in case someone wants to update it, extra points for using a scripting solution to make it reproducable. Also see the howto document document

@eric-wieser
Copy link
Member

@eric-wieser eric-wieser commented Oct 23, 2020

I'd caution marking this "good first issue", else we might end up with a thread similar to sympy/sympy#15331.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

4 participants
You can’t perform that action at this time.