[IMP] Contributing: list table customization parameters

[ghost]

Custom parameters for list tables

for V17.0 +

[robodoo]

[ghost]

The sticky-table parameter has not yet been merged from Niki's PR, but it is approved (had to be redirected to 17.0 instead of 19.0)

*************The above original comment is incorrect. Please follow thread for more accurate info.

[AntoineVDV]

@auva-odoo for context, here is the PR to introduce the feature: #16384. It's actually not approved yet, so I suggest you wait until it reaches a final status (merged or closed) before reviewing this one.

[Felicious]

Hi @MCG357 !

I'll let @auva-odoo make the final call since she owns the documentation standards. From my perspective, this section goes into more implementation detail than necessary for our contributor guidelines.

Table usage is relatively limited in our workflow-focused documentation, and we aim to optimize doc style for LLM readability, and as per AWS RAG guidelines, tables are generally discouraged.

Given that, it may be sufficient to provide brief guidance here and link to the official Sphinx documentation for full directive options, unless there is a need and clear confusion among our documentation contributors that table formatting is something they struggle with.

[ghost]

@Felicious Thank you for the feedback. I adjusted the formatting, added the suggested Sphinx directives link, made, and reviewed.

[auva-odoo]

Thank you for this update @MCG357 🤗 I agree with @Felicious 100%, thank you for making that change already! I added a few minor comments 🙂

[ghost]

Thank you @auva-odoo and @Felicious for the feedback! I have updated per suggestions. Niki's sticky-header PR is not yet approved (I apologize for misspeaking earlier in the thread). Thank you! : )

[ghost]

All suggestions implemented. Thank you! @Felicious and @auva-odoo : )

[ghost]

Sticky-header PR merged per Niki : )

[Felicious]

line exceeds 100 characters.

have you installed the writer setup tool yet? this would automatically run make review and catch lines that exceed 100 characters before you commit (:

[ghost]

@Felicious I do! I noticed this document had many cases of the character limit being exceeded and so was under the impression this document was an exception.

[Felicious]

Let's ensure the lines you've touched in this update align with content and style guidelines of the team

[ghost]

Ok, do you want me to update the pre-existing make review flags or just my own in this case? Thanks! @Felicious

[ghost]

I fixed the lines I was responsible for. Thank you!

[auva-odoo]

I'll go ahead and approve this already and let @Felicious check this one last time and r+ it. thank you very much for taking care of this @MCG357!

[ghost]

Pre-existing make review results:
content/contributing/documentation/rst_guidelines.rst:363: consider moving "item" to line 363 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:369: consider moving "item" to line 369 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:391: consider moving "with" to line 391 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:397: consider moving "with" to line 397 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:452: consider moving "```label" to line 452 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:456: consider moving "another" to line 456 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:507: consider moving "or" to line 507 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:524: consider moving "::" to line 524 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:609: consider moving "about" to line 609 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:616: consider moving "-------------------" to line 616 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:621: consider moving "~~~~~~~" to line 621 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:624: consider moving "about" to line 624 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:938: consider moving "print("Hello" to line 938 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:1224: consider moving "std::cout" to line 1224 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:1225: consider moving "return" to line 1225 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:1226: consider moving "}" to line 1226 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:1290: consider moving "It" to line 1290 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:1372: consider moving "->" to line 1372 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:1387: consider moving "**line" to line 1387 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:1392: consider moving "an" to line 1392 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:1394: consider moving "``[UNKNOWN" to line 1394 (early-line-breaks)
content/contributing/documentation/rst_guidelines.rst:28: Line too long (101/100) (line-too-long)
content/contributing/documentation/rst_guidelines.rst:492: Line too long (101/100) (line-too-long)
content/contributing/documentation/rst_guidelines.rst:493: Line too long (101/100) (line-too-long)
content/contributing/documentation/rst_guidelines.rst:573: Line too long (104/100) (line-too-long)
content/contributing/documentation/rst_guidelines.rst:643: Line too long (123/100) (line-too-long)
content/contributing/documentation/rst_guidelines.rst:701: Line too long (137/100) (line-too-long)
content/contributing/documentation/rst_guidelines.rst:718: Line too long (112/100) (line-too-long)
content/contributing/documentation/rst_guidelines.rst:799: Line too long (118/100) (line-too-long)
make: *** [Makefile:101: review] Error 1

Make review line fixed (my contribution):
content/contributing/documentation/rst_guidelines.rst:887: Line too long (125/100) (line-too-long)

Thank you!

[Felicious]

Hi @MCG357,

Left some comments for sentence flow and consistency with the rest of the doc

After you implement those, we can merge

[Felicious]

@robodoo r+