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 asterisk in cron table being rendered as list item #4836

Merged
merged 2 commits into from
Feb 9, 2024

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Feb 5, 2024

Why are the changes needed?

The asterisks in the cron table in the Schedules doc are rendering as list items instead of asterisks.

What changes were proposed in this pull request?

Simply escaping the asterisk didn't work, since it's in a table, so I turned the rst table into an HTML table and that seemed to fix the issue.

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Docs link

https://flyte--4836.org.readthedocs.build/en/4836/concepts/schedules.html

@neverett neverett requested a review from ppiegaze February 5, 2024 22:07
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Feb 5, 2024
@@ -95,6 +176,7 @@ Below is an example with duration in `days`.

)

.. _rate_unit:

Rate Unit
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is outside the scope of this PR, but I don't understand the difference between this section and the "Fixed rate schedules" section above.

@neverett neverett changed the title Fix asterisk in cron table being rendered as list element Fix asterisk in cron table being rendered as list item Feb 5, 2024
Copy link

codecov bot commented Feb 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1bbe867) 58.98% compared to head (bc27e6a) 58.48%.
Report is 16 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4836      +/-   ##
==========================================
- Coverage   58.98%   58.48%   -0.50%     
==========================================
  Files         567      567              
  Lines       44496    50533    +6037     
==========================================
+ Hits        26244    29555    +3311     
- Misses      15858    18584    +2726     
  Partials     2394     2394              
Flag Coverage Δ
unittests 58.48% <ø> (+1.13%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Feb 9, 2024
@neverett neverett self-assigned this Feb 9, 2024
@neverett neverett merged commit 55a67f2 into master Feb 9, 2024
48 of 49 checks passed
@neverett neverett deleted the docs/fix-asterisk branch February 9, 2024 17:09
katrogan pushed a commit that referenced this pull request Feb 20, 2024
yubofredwang pushed a commit to yubofredwang/flyte that referenced this pull request Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants