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

Docstring cleanup #665

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

heinrich26
Copy link

Replaced occurences of `` / ' with ` in Docstrings

Copy link

codecov bot commented Oct 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.04%. Comparing base (8f479b1) to head (1b493b9).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #665   +/-   ##
=======================================
  Coverage   95.04%   95.04%           
=======================================
  Files          38       38           
  Lines        2282     2282           
=======================================
  Hits         2169     2169           
  Misses        113      113           
Flag Coverage Δ
unittests 95.04% <ø> (ø)

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.

Copy link
Owner

@sigma67 sigma67 left a comment

Choose a reason for hiding this comment

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

There is a semantic difference between ` and ``

https://docutils.sourceforge.io/docs/user/rst/quickref.html#inline-markup

In this case, double backtick is correct. Using single backtick while show up differently in the rendered HTML markup

`Test` vs ``test``.

image

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.

2 participants