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

Fix markdown format for table rows #829

Merged
merged 1 commit into from
Sep 27, 2021

Conversation

codificat
Copy link
Member

Related Issues and Dependencies

#822

This introduces a breaking change

  • No

This Pull Request implements

Fix the markdown formatting of the package rows in the table within update PRs.

Description

The fix in #823 fixes the formatting of the header of the table in the reported issues by adding the missing leading |.

This PR adds that pipe char to the rows that go after the header, i.e. the rest of the table, formed by the list of packages to update.

@sesheta sesheta added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 21, 2021
@@ -703,7 +703,9 @@ def _generate_update_body(self, outdated: dict) -> str:
details.get("new_version"),
details.get("dev"),
)
package_name_rows += f"**{package}**|{old_version}|{new_version}|{is_dev}\n"
package_name_rows += (
f"|**{package}**|{old_version}|{new_version}|{is_dev}\n"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
f"|**{package}**|{old_version}|{new_version}|{is_dev}\n"
f"|**{package}**|{old_version}|{new_version}|{is_dev}|\n"

Copy link
Member Author

Choose a reason for hiding this comment

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

heh, good point, thanks! I'll add that trailing pipe too

Add leading and traling | chars to clarify markdown for table rows

Signed-off-by: Pep Turró Mauri <[email protected]>
Copy link
Member

@harshad16 harshad16 left a comment

Choose a reason for hiding this comment

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

thanks 💯

@sesheta
Copy link
Member

sesheta commented Sep 27, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: harshad16, KPostOffice

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@sesheta sesheta added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 27, 2021
@sesheta sesheta merged commit f67ef39 into thoth-station:master Sep 27, 2021
@codificat codificat deleted the format-update-rows branch October 19, 2021 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants