Skip to content

Commit

Permalink
Satisfy linter (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
kandersolar authored Feb 26, 2023
1 parent 55ccb1c commit 938cac6
Show file tree
Hide file tree
Showing 9 changed files with 48 additions and 46 deletions.
76 changes: 38 additions & 38 deletions docs/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
Expand Down Expand Up @@ -63,7 +63,7 @@
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'
Expand Down Expand Up @@ -91,37 +91,37 @@

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', '**.ipynb_checkpoints', 'whatsnew/*']

# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# keep_warnings = False

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
Expand Down Expand Up @@ -151,14 +151,14 @@
"""

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# html_theme_path = []

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
Expand All @@ -177,15 +177,15 @@
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# html_extra_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
html_sidebars = {
Expand All @@ -199,47 +199,47 @@

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True
# html_domain_indices = True

# If false, no index is generated.
#html_use_index = True
# html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False
# html_split_index = False

# If true, links to the reST sources are added to the pages.
html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# html_file_suffix = None

# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
#html_search_language = 'en'
# html_search_language = 'en'

# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
#html_search_options = {'type': 'default'}
# html_search_options = {'type': 'default'}

# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#html_search_scorer = 'scorer.js'
# html_search_scorer = 'scorer.js'

# Output file base name for HTML help builder.
htmlhelp_basename = 'pvfactorsdoc'
Expand Down Expand Up @@ -270,23 +270,23 @@

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False
# latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []
# latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True
# latex_domain_indices = True


# -- Options for manual page output ---------------------------------------
Expand All @@ -299,7 +299,7 @@
]

# If true, show URL addresses after external links.
#man_show_urls = False
# man_show_urls = False


# -- Options for Texinfo output -------------------------------------------
Expand All @@ -314,16 +314,16 @@
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True
# texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# texinfo_no_detailmenu = False

# turns off numpydoc autosummary warnings
numpydoc_show_class_members = False
Expand Down
4 changes: 2 additions & 2 deletions pvfactors/__init__.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# -*- coding: utf-8 -*-

from pvfactors.version import __version__
from pvfactors.version import __version__ # noqa: F401
import logging
logging.basicConfig()

try:
from shapely.geos import lgeos
from shapely.geos import lgeos # noqa: F401
except OSError as err:
# https://github.com/SunPower/pvfactors/issues/109
msg = (
Expand Down
2 changes: 1 addition & 1 deletion pvfactors/geometry/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""Geometry classes"""

from pvfactors.geometry.pvarray import OrderedPVArray
from pvfactors.geometry.pvarray import OrderedPVArray # noqa: F401
2 changes: 1 addition & 1 deletion pvfactors/irradiance/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""Irradiance models"""

from pvfactors.irradiance.models import IsotropicOrdered, HybridPerezOrdered
from pvfactors.irradiance.models import IsotropicOrdered, HybridPerezOrdered # noqa: F401
3 changes: 2 additions & 1 deletion pvfactors/irradiance/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -807,7 +807,8 @@ def get_full_ts_modeling_vectors(self, pvarray):
and sky. Dimension = [n_surfaces + 1, n_timesteps]
"""
# Sum up the necessary parameters to form the irradiance vector
irradiance_mat, rho_mat, inv_rho_mat, total_perez_mat = self.get_ts_modeling_vectors(pvarray)
irradiance_mat, rho_mat, inv_rho_mat, total_perez_mat = \
self.get_ts_modeling_vectors(pvarray)
# Add sky values
irradiance_mat.append(self.isotropic_luminance)
total_perez_mat.append(self.isotropic_luminance)
Expand Down
1 change: 0 additions & 1 deletion pvfactors/tests/test_viewfactors/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +0,0 @@
from pvfactors.viewfactors.calculator import VFCalculator
2 changes: 1 addition & 1 deletion pvfactors/viewfactors/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""View factor calculator"""

from pvfactors.viewfactors.calculator import VFCalculator
from pvfactors.viewfactors.calculator import VFCalculator # noqa: F401
3 changes: 2 additions & 1 deletion pvfactors/viewfactors/vfmethods.py
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,8 @@ def calculate_vf_to_shadow_obstruction_hottel(
Parameters
----------
pvrow_element : :py:class:`~pvfactors.geometry.timeseries.TsDualSegment` or :py:class:`~pvfactors.geometry.timeseries.TsSurface`
pvrow_element : :py:class:`~pvfactors.geometry.timeseries.TsDualSegment`\
or :py:class:`~pvfactors.geometry.timeseries.TsSurface`
Timeseries pvrow_element to use for calculation
pvrow_idx : int
Index of the timeseries PV row on the which the pvrow_element is
Expand Down
1 change: 1 addition & 0 deletions versioneer.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# flake8: noqa

# Version: 0.18

Expand Down

0 comments on commit 938cac6

Please sign in to comment.