Skip to content

Fix spec links and shorten line lengths #368

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

Merged
merged 4 commits into from
Jun 1, 2021

Conversation

duckontheweb
Copy link
Contributor

@duckontheweb duckontheweb commented May 27, 2021

Description:

  • Fixes GitHub username in docs/conf.py
  • Uses the :stac-spec: extlink for all links to the STAC spec. This will automatically generate links to the version of the spec from pystac.version.STACVersion.DEFAULT_STAC_VERSION (there were a number of these links that were still pointing to old spec versions).
  • Uses the :stac-ext: extlink for all links to STAC Extensions specs.
  • Updates RST files to have a max line length of 88 to match linting on other files
  • Uses doc8 to lint all source files for the docs (except tutorials) as part of ./scripts/test
    If this last one seems too heavy-handed I'm happy to remove it, but I thought it would help keep us from getting some of the really long lines that had snuck in before.

PR Checklist:

  • Code is formatted (run scripts/format)
  • Tests pass (run scripts/test)
  • This PR maintains or improves overall codebase code coverage.
  • Changes are added to the CHANGELOG. See the docs for information about adding to the changelog.

@codecov-commenter
Copy link

codecov-commenter commented May 27, 2021

Codecov Report

Merging #368 (984b2e9) into main (e90f809) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #368   +/-   ##
=======================================
  Coverage   89.77%   89.77%           
=======================================
  Files          37       37           
  Lines        4677     4677           
=======================================
  Hits         4199     4199           
  Misses        478      478           
Impacted Files Coverage Δ
pystac/catalog.py 93.51% <ø> (ø)
pystac/extensions/label.py 85.89% <ø> (ø)
pystac/layout.py 92.44% <ø> (ø)
pystac/stac_object.py 95.08% <ø> (ø)

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 e90f809...984b2e9. Read the comment docs.

@duckontheweb duckontheweb requested review from lossyrob and kbgg May 28, 2021 15:14
@duckontheweb duckontheweb merged commit 7e4602f into stac-utils:main Jun 1, 2021
@duckontheweb duckontheweb deleted the doc-fixes branch June 1, 2021 17:45
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.

4 participants