docs(table): added documentation for the 'new' method of the 'table' widget

[DreadedHippy]

Added documentation for the new method of the Table widget

[codecov]

Codecov Report

Merging #471 (f8e9a0c) into main (c8ab2d5) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #471   +/-   ##
=======================================
  Coverage   90.06%   90.06%           
=======================================
  Files          40       40           
  Lines       11166    11166           
=======================================
  Hits        10057    10057           
  Misses       1109     1109           

Files Changed	Coverage Δ
src/widgets/table.rs	94.82% <ø> (ø)

[DreadedHippy]

Oh, the gramatical error failing the lint CI comes from the commit message and not the diff. Noted

[joshka]

Oh, the gramatical error failing the lint CI comes from the commit message and not the diff. Noted

Yeah - the convention is imperative form ("add" instead of "added") as if you're completing the sentence “If applied, this commit will …”
There's a couple of good blog posts that talk more about the rationale for this:

• https://www.conventionalcommits.org/en/v1.0.0/ gives the dry detail
• https://bitcrowd.dev/a-note-on-commit-messages/ gives some context
• https://cbea.ms/git-commit/ goes deep
• https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html is one canonical post that everyone refers to

[DreadedHippy]

Oh, the gramatical error failing the lint CI comes from the commit message and not the diff. Noted

Yeah - the convention is imperative form ("add" instead of "added") as if you're completing the sentence “If applied, this commit will …” There's a couple of good blog posts that talk more about the rationale for this:

• https://www.conventionalcommits.org/en/v1.0.0/ gives the dry detail
• https://bitcrowd.dev/a-note-on-commit-messages/ gives some context
• https://cbea.ms/git-commit/ goes deep
• https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html is one canonical post that everyone refers to

Thank you very much for this