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

Explicitly set a language #739

Merged
merged 1 commit into from
Jun 14, 2022
Merged

Explicitly set a language #739

merged 1 commit into from
Jun 14, 2022

Conversation

mjpieters
Copy link
Contributor

What do these changes do?

Change the Sphinx language parameter from None to en, explicitly setting
the language.

All documentation is in English, and Sphinx 5 complains loudly if this isn't
set.

Related issue number

#733, a dependabot PR that upgrades Sphinx to 5.0.1. The CI lint step fails due
to the warning.

Checklist

  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> (e.g. 588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the PR
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: Fix issue with non-ascii contents in doctest text files.

All documentation is in English, and Sphinx 5 complains loudly if this isn't
set.
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Jun 14, 2022
@codecov
Copy link

codecov bot commented Jun 14, 2022

Codecov Report

Merging #739 (dece339) into master (80174ca) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #739   +/-   ##
=======================================
  Coverage   99.73%   99.73%           
=======================================
  Files           4        4           
  Lines         750      750           
  Branches      212      212           
=======================================
  Hits          748      748           
  Misses          2        2           
Flag Coverage Δ
unit 99.60% <ø> (ø)

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


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 80174ca...dece339. Read the comment docs.

@mjpieters mjpieters enabled auto-merge (squash) June 14, 2022 12:21
@mjpieters mjpieters merged commit 1a60f70 into master Jun 14, 2022
@mjpieters mjpieters deleted the sphinx_language branch June 14, 2022 12:23
@mjpieters mjpieters restored the sphinx_language branch June 14, 2022 12:24
@mjpieters mjpieters deleted the sphinx_language branch June 14, 2022 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant