Le 30/08/2022 à 21:08, Kae Suarez a écrit :
I do not know about the namespace issue in the API reference, but when
focusing on the User's Guide and Getting Started sections, we can announce
at the top of the page what namespace is relevant. I personally recommend
using only the arrow namespace
I do not know about the namespace issue in the API reference, but when
focusing on the User's Guide and Getting Started sections, we can announce
at the top of the page what namespace is relevant. I personally recommend
using only the arrow namespace for ease in documentation and being more
manual
"Always linking" sounds reasonable to me. It also makes the decision easier,
for both author and reviewer.
I feel like there must be some way to configure Breathe or Sphinx to show the
namespace in Antoine's example, but I don't see it…
On Tue, Aug 30, 2022, at 08:52, Antoine Pitrou wrote:
> H
Hello Kae,
Le 29/08/2022 à 19:28, Kae Suarez a écrit :
I personally like the idea of using namespace directives in Sphinx to keep
things less cluttered and easier to write, then using the class directive
each time so links are always available.
I would agree with this. As for the namespace,
Hello,
I am currently creating some new documentation here:
https://github.com/apache/arrow/pull/13859, and would like to enhance other
documentation over time, so I would like to figure out best practices.
However, some areas lack standardization in the documentation.
In particular, classes are
