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 Sphinx warnings related to whitespace #197

Merged
merged 3 commits into from
Apr 12, 2021

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented Apr 10, 2021

There's quite a few Sphinx warnings I found when working on #196. For example:

icepyx/doc/source/community/contact.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
icepyx/doc/source/community/resources.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
../ATTRIBUTION.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
icepyx/icepyx/core/Earthdata.py:docstring of icepyx.core.Earthdata.Earthdata.login:17: WARNING: Unexpected indentation.
icepyx/icepyx/core/Earthdata.py:docstring of icepyx.core.Earthdata.Earthdata.login:18: WARNING: Block quote ends without a blank line; unexpected unindent.
icepyx/icepyx/core/variables.py:docstring of icepyx.core.variables.Variables.parse_var_list:69: WARNING: Explicit markup ends without a blank line; unexpected unindent.
icepyx/doc/source/user_guide/documentation/icepyx.rst:9: WARNING: Explicit markup ends without a blank line; unexpected unindent.

So, to make things easier to review, this PR was created separately so as to reduce the diff on #196. The main changes are:

  • Ensure API docs are generated to gitignored doc/source/_icepyx folder (41eb52d)
  • Fix whitespace issues in *.rst files (38bac7e)
  • Fix whitespace issues in Earthdata.py and variables.py (54a420f)

Adding or removing spaces so that Sphinx stops complaining like "WARNING: Explicit markup ends without a blank line".
@codecov-io
Copy link

Codecov Report

Merging #197 (54a420f) into development (c4439e4) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##           development     #197   +/-   ##
============================================
  Coverage        50.50%   50.50%           
============================================
  Files               17       17           
  Lines             1281     1281           
  Branches           280      280           
============================================
  Hits               647      647           
  Misses             581      581           
  Partials            53       53           
Impacted Files Coverage Δ
icepyx/core/Earthdata.py 20.37% <ø> (ø)
icepyx/core/variables.py 8.37% <ø> (ø)

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 c4439e4...54a420f. Read the comment docs.

@weiji14 weiji14 self-assigned this Apr 10, 2021
Copy link
Member

@JessicaS11 JessicaS11 left a comment

Choose a reason for hiding this comment

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

I thought these were all run through a linter at some point, but apparently not quite - thanks for fixing all of these whitespace issues.

@JessicaS11 JessicaS11 merged commit a582a27 into development Apr 12, 2021
@JessicaS11 JessicaS11 deleted the sphinx-whitespace-fixes branch April 12, 2021 21:20
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