Skip to content

Capitalise module level constants #233

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 3 commits into from
Apr 14, 2022
Merged

Capitalise module level constants #233

merged 3 commits into from
Apr 14, 2022

Conversation

pankajkoti
Copy link
Collaborator

@pankajkoti pankajkoti commented Apr 14, 2022

We should Captailaize module level constants not used by Sphinx as a convention

docs/conf.py Outdated

# -- Project information -----------------------------------------------------

project = "Astronomer Providers"
author = "Astronomer Inc."
PROJECT = "Astronomer Providers"
Copy link
Collaborator

@kaxil kaxil Apr 14, 2022

Choose a reason for hiding this comment

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

We can't do the others though as they are needed by Sphinx.

We only can do that are used internally, like REPO_DIR. Feel free to make it internal if you want to by adding _ i.e. _REPO_DIR

docs/conf.py Outdated
@@ -34,7 +34,7 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
_EXTENSIONS = [
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
_EXTENSIONS = [
extensions = [

Copy link
Collaborator

Choose a reason for hiding this comment

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

This is also used by Sphinx for extensions

Copy link
Collaborator

Choose a reason for hiding this comment

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

@codecov
Copy link

codecov bot commented Apr 14, 2022

Codecov Report

Merging #233 (8f48c23) into main (2ca7497) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #233   +/-   ##
=======================================
  Coverage   96.34%   96.34%           
=======================================
  Files          45       45           
  Lines        2541     2541           
=======================================
  Hits         2448     2448           
  Misses         93       93           

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 2ca7497...8f48c23. Read the comment docs.

@kaxil kaxil merged commit 07c987a into main Apr 14, 2022
@kaxil kaxil deleted the capitalise-constants-PR-228 branch April 14, 2022 14:49
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