Repository navigation
Add documentation for LaTeX formatted tables with units - #17627
Conversation
|
Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.
|
hamogu
left a comment
There was a problem hiding this comment.
I looked for a while what the best location for that added documentation would be. It makes the docstring pretty long in the location where it is now. However, I found that throughout the docs we always link to this docstring when the talk about reading and writing LaTeX tables, so I think this is a natural place where people can find it. It is LaTeX specific as written, so I think it's better here then on a general "tips and ticks" pages (that we don't have like that anyway). Alternatively, one could move it down below the description of the keywords.
mhvk
left a comment
There was a problem hiding this comment.
Nice! Some suggestions inline for avoiding having to spell out the table in the second example.
Also, I wondered a bit about how people would find this, but found that both google and duckduckgo have the docs for this class as one of the first entries when one searches "astropy write latex table". And of course t.write.help("ascii.latex") does too, though I wonder how many people would know to try that...
I only discovered that while writing this PR and I've been an |
…627-on-v7.0.x Backport PR #17627 on branch v7.0.x (Add documentation for LaTeX formatted tables with units)
Description
This pull request adds documentation that explicitly explaines why LaTeX tables are written with units, but reading the units in LaTeX tables is out of scope. An example for ignoring a lines with units in the table is added.
Fixes #14853