Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format tables in docs to improve readability #278

Merged

Conversation

froschdesign
Copy link
Member

@froschdesign froschdesign commented Oct 8, 2024

Adjusted table formatting in multiple documentation files for better readability and consistency. Reformatted method signatures and descriptions to align properly within the tables across various documentation sections.

Documentation Linting Errors

Error: docs/book/v2/element/captcha.md:52:70 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v2/element/collection.md:56:57 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v2/element/collection.md:57:57 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v2/element/collection.md:62:57 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v2/element/collection.md:71:46 MD056/table-column-count Table column count [Expected: 2; Actual: 4; Too many cells, extra data will be missing]
Error: docs/book/v2/element/element.md:50:53 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v2/element/element.md:55:63 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v2/element/element.md:56:53 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v2/element/element.md:59:53 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v2/element/element.md:60:53 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v2/element/select.md:139:42 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v2/helper/form-label.md:71:72 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v3/element/captcha.md:52:70 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v3/element/collection.md:62:57 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v3/element/collection.md:71:46 MD056/table-column-count Table column count [Expected: 2; Actual: 4; Too many cells, extra data will be missing]
Error: docs/book/v3/element/element.md:50:53 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v3/element/select.md:139:42 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]
Error: docs/book/v3/helper/form-label.md:71:72 MD056/table-column-count Table column count [Expected: 2; Actual: 3; Too many cells, extra data will be missing]

https://github.com/laminas/laminas-form/actions/runs/11071191085/job/31222387945

(The Markdown plugin for IDEs from Jetbrains helps here.)

Adjusted table formatting in multiple documentation files for better readability and consistency. Reformatted method signatures and descriptions to align properly within the tables across various documentation sections.

Signed-off-by: Frank Brückner <dev@froschdesignstudio.de>
@froschdesign froschdesign added Bug Something isn't working Documentation labels Oct 8, 2024
@froschdesign froschdesign mentioned this pull request Oct 8, 2024
Copy link
Member

@gsteel gsteel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@Xerkus Xerkus added this to the 3.21.0 milestone Oct 8, 2024
@Xerkus
Copy link
Member

Xerkus commented Oct 8, 2024

Oof. Having to format that without a tool would be a nightmare

@Xerkus Xerkus merged commit 399df94 into laminas:3.21.x Oct 8, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants