Skip to content

Commit 8aa8d53

Browse files
committed
editing docs
1 parent 9d8c374 commit 8aa8d53

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

docs/sphinx/source/package_overview.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,11 @@ is well-tested procedural code that implements PV system models.
2020
pvlib-python also provides a collection of classes for users
2121
that prefer object-oriented programming.
2222
These classes can help users keep track of data in a more organized way,
23-
and can help to simplify the modeling process.
24-
The classes do not add any functionality beyond the procedural code.
25-
Most of the object methods are simple wrappers around the
26-
corresponding procedural code.
23+
provide some "smart" functions with more flexible inputs,
24+
and simplify the modeling process for common situations.
25+
The classes do not add any algorithms beyond what's available
26+
in the procedural code, and most of the object methods
27+
are simple wrappers around the corresponding procedural code.
2728

2829
Let's use each of these pvlib modeling paradigms
2930
to calculate the yearly energy yield for a given hardware

pvlib/pvsystem.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,12 @@ class PVSystem(object):
3030
The PVSystem class defines a standard set of PV system attributes and
3131
modeling functions. This class describes the collection and interactions
3232
of PV system components rather than an installed system on the ground.
33-
It is typically used in combination with ``Location`` and ``ModelChain``
33+
It is typically used in combination with
34+
:py:class:`~pvlib.location.Location` and
35+
:py:class:`~pvlib.modelchain.ModelChain`
3436
objects.
3537
36-
See the :class:`LocalizedPVSystem` class for an object model that
38+
See the :py:class:`LocalizedPVSystem` class for an object model that
3739
describes an installed PV system.
3840
3941
The class is complementary
@@ -88,9 +90,9 @@ class PVSystem(object):
8890
8991
See also
9092
--------
91-
location.Location
92-
tracking.SingleAxisTracker
93-
pvsystem.LocalizedPVSystem
93+
:py:class:`~pvlib.location.Location`
94+
:py:class:`~pvlib.tracking.SingleAxisTracker`
95+
:py:class:`~pvlib.pvsystem.LocalizedPVSystem`
9496
"""
9597

9698
def __init__(self,
@@ -406,7 +408,7 @@ class LocalizedPVSystem(PVSystem, Location):
406408
This class combines the attributes and methods
407409
of the PVSystem and Location classes.
408410
409-
See the :class:`PVSystem` class for an object model that
411+
See the :py:class:`PVSystem` class for an object model that
410412
describes an unlocalized PV system.
411413
"""
412414
def __init__(self, pvsystem=None, location=None, **kwargs):

0 commit comments

Comments
 (0)