Skip to content

fix broken seealso docstring entries #946

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 1 commit into from
Mar 31, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pvlib/clearsky.py
Original file line number Diff line number Diff line change
Expand Up @@ -855,7 +855,7 @@ def bird(zenith, airmass_relative, aod380, aod500, precipitable_water,
See also
--------
pvlib.atmosphere.bird_hulstrom80_aod_bb
pvlib.atmosphere.relativeairmass
pvlib.atmosphere.get_relative_airmass

References
----------
Expand Down
50 changes: 25 additions & 25 deletions pvlib/iam.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ def ashrae(aoi, b=0.05):

See Also
--------
iam.physical
iam.martin_ruiz
iam.interp
pvlib.iam.physical
pvlib.iam.martin_ruiz
pvlib.iam.interp
"""

iam = 1 - b * ((1 / np.cos(np.radians(aoi)) - 1))
Expand Down Expand Up @@ -143,10 +143,10 @@ def physical(aoi, n=1.526, K=4., L=0.002):

See Also
--------
iam.martin_ruiz
iam.ashrae
iam.interp
iam.sapm
pvlib.iam.martin_ruiz
pvlib.iam.ashrae
pvlib.iam.interp
pvlib.iam.sapm
"""
zeroang = 1e-06

Expand Down Expand Up @@ -248,11 +248,11 @@ def martin_ruiz(aoi, a_r=0.16):

See Also
--------
iam.martin_ruiz_diffuse
iam.physical
iam.ashrae
iam.interp
iam.sapm
pvlib.iam.martin_ruiz_diffuse
pvlib.iam.physical
pvlib.iam.ashrae
pvlib.iam.interp
pvlib.iam.sapm
'''
# Contributed by Anton Driesse (@adriesse), PV Performance Labs. July, 2019

Expand Down Expand Up @@ -334,11 +334,11 @@ def martin_ruiz_diffuse(surface_tilt, a_r=0.16, c1=0.4244, c2=None):

See Also
--------
iam.martin_ruiz
iam.physical
iam.ashrae
iam.interp
iam.sapm
pvlib.iam.martin_ruiz
pvlib.iam.physical
pvlib.iam.ashrae
pvlib.iam.interp
pvlib.iam.sapm
'''
# Contributed by Anton Driesse (@adriesse), PV Performance Labs. Oct. 2019

Expand Down Expand Up @@ -424,10 +424,10 @@ def interp(aoi, theta_ref, iam_ref, method='linear', normalize=True):

See Also
--------
iam.physical
iam.ashrae
iam.martin_ruiz
iam.sapm
pvlib.iam.physical
pvlib.iam.ashrae
pvlib.iam.martin_ruiz
pvlib.iam.sapm
'''
# Contributed by Anton Driesse (@adriesse), PV Performance Labs. July, 2019

Expand Down Expand Up @@ -507,10 +507,10 @@ def sapm(aoi, module, upper=None):

See Also
--------
iam.physical
iam.ashrae
iam.martin_ruiz
iam.interp
pvlib.iam.physical
pvlib.iam.ashrae
pvlib.iam.martin_ruiz
pvlib.iam.interp
"""

aoi_coeff = [module['B5'], module['B4'], module['B3'], module['B2'],
Expand Down
2 changes: 1 addition & 1 deletion pvlib/location.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class Location(object):

See also
--------
pvsystem.PVSystem
pvlib.pvsystem.PVSystem
"""

def __init__(self, latitude, longitude, tz='UTC', altitude=0,
Expand Down
8 changes: 4 additions & 4 deletions pvlib/pvsystem.py
Original file line number Diff line number Diff line change
Expand Up @@ -955,8 +955,8 @@ def systemdef(meta, surface_tilt, surface_azimuth, albedo, modules_per_string,

See also
--------
pvlib.tmy.readtmy3
pvlib.tmy.readtmy2
pvlib.iotools.read_tmy3
pvlib.iotools.read_tmy2
'''

try:
Expand Down Expand Up @@ -1689,8 +1689,8 @@ def sapm(effective_irradiance, temp_cell, module):
See Also
--------
retrieve_sam
temperature.sapm_cell
temperature.sapm_module
pvlib.temperature.sapm_cell
pvlib.temperature.sapm_module
'''

# TODO: someday, change temp_ref and irrad_ref to reference_temperature and
Expand Down
4 changes: 2 additions & 2 deletions pvlib/solarposition.py
Original file line number Diff line number Diff line change
Expand Up @@ -1126,7 +1126,7 @@ def equation_of_time_pvcdrom(dayofyear):

See Also
--------
equation_of_time_Spencer71
equation_of_time_spencer71
"""
# day angle relative to Vernal Equinox, typically March 22 (day number 81)
bday = \
Expand Down Expand Up @@ -1380,7 +1380,7 @@ def hour_angle(times, longitude, equation_of_time):

See Also
--------
equation_of_time_Spencer71
equation_of_time_spencer71
equation_of_time_pvcdrom
"""
naive_times = times.tz_localize(None) # naive but still localized
Expand Down