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 yields in docstring for rst generation #692

Merged

Conversation

Miauwkeru
Copy link
Contributor

No description provided.

@Miauwkeru Miauwkeru requested a review from narimantos April 25, 2024 15:19
@codecov-commenter
Copy link

codecov-commenter commented Apr 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.19%. Comparing base (3bca243) to head (0208fe9).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #692   +/-   ##
=======================================
  Coverage   75.19%   75.19%           
=======================================
  Files         292      292           
  Lines       24848    24848           
=======================================
  Hits        18685    18685           
  Misses       6163     6163           
Flag Coverage Δ
unittests 75.19% <ø> (ø)

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.

@narimantos
Copy link
Contributor

the highlighting seems a bit off. See below:
image

Maybe try doing it with the code-block? .. code-block:: text

narimantos
narimantos previously approved these changes May 15, 2024
Copy link
Contributor

@narimantos narimantos left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@Miauwkeru Miauwkeru force-pushed the DIS-3161_missing-new-lines-in-record-yield-description branch from 2f61b7f to c02e1c0 Compare May 15, 2024 09:15
Yields SchedLgURecord with fields:

.. code-block:: text

ts (datetime): The timestamp of the event.
job (str): The name of the ``.job`` file.
Copy link
Contributor

@narimantos narimantos May 15, 2024

Choose a reason for hiding this comment

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

this doesn't format.

@Miauwkeru Miauwkeru force-pushed the DIS-3161_missing-new-lines-in-record-yield-description branch from 854f513 to 02a91d5 Compare May 16, 2024 09:10
@Miauwkeru Miauwkeru merged commit 76e3577 into main May 16, 2024
16 checks passed
@Miauwkeru Miauwkeru deleted the DIS-3161_missing-new-lines-in-record-yield-description branch May 16, 2024 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants