AlenkaF commented on issue #47471: URL: https://github.com/apache/arrow/issues/47471#issuecomment-3245441228
Most style decisions are enforced by our linters, so I generally rely on them. For Python, we follow the PEP-8 coding guidelines, which include comment styles, and use the NumPy style for docstrings (including sections like Notes; see [https://numpydoc.readthedocs.io/en/latest/format.html#notes](https://numpydoc.readthedocs.io/en/latest/format.html?utm_source=chatgpt.com#notes)). As @kou mentioned in the linked comment, our C++ code documentation follows the Doxygen style. It might be worthwhile to clarify these style conventions in our official documentation. Regarding punctuation in comments, such as whether to include a period at the end of a line, I believe our existing C++ linters handle most issues, and such minor formatting details may be treated as less critical? I seem to find both examples in our codebase. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
