Skip to content

Commit

Permalink
style(docs): Fix several docstrings for Sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
chriswmackey committed Oct 16, 2024
1 parent 216dfe4 commit 5eb9b8d
Show file tree
Hide file tree
Showing 11 changed files with 45 additions and 45 deletions.
12 changes: 6 additions & 6 deletions ladybug_display/extension/adaptivechart.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,20 @@ def adaptive_chart_to_vis_set(
in the following order.
- Title -- A ContextGeometry for the title and border around the
adaptive chart.
adaptive chart.
- Prevailing_Axis -- A ContextGeometry with lines and text for the
Prevailing Outdoor Temperature (X) axis of the adaptive chart.
Prevailing Outdoor Temperature (X) axis of the adaptive chart.
- Operative_Axis -- A ContextGeometry with lines and text for the
Indoor Operative Temperature (Y) axis of the adaptive chart.
Indoor Operative Temperature (Y) axis of the adaptive chart.
- Comfort_Polygon -- A ContextGeometry with lines for the comfort polygon
and neutral temperature of the adaptive chart.
and neutral temperature of the adaptive chart.
- Analysis_Data -- An AnalysisGeometry for the data on the adaptive
chart. This will include multiple data sets if the data input
is provided.
chart. This will include multiple data sets if the data input
is provided.
"""
# establish the VisualizationSet object
vis_set = VisualizationSet('Adaptive_Chart', ())
Expand Down
8 changes: 4 additions & 4 deletions ladybug_display/extension/compass.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,16 @@ def compass_to_vis_set(compass, z=0, custom_angles=None, projection=None, font='
- major_azimuth_text -- Text objects for the major azimuth labels.
- minor_azimuth_ticks -- Line objects for the minor azimuth labels
(if applicable).
(if applicable).
- minor_azimuth_text -- Text objects for the minor azimuth
labels (if applicable).
labels (if applicable).
- altitude_circles -- Circle objects for altitude labels (if projection
is not None).
is not None).
- altitude_text -- Text objects for altitude labels (if projection
is not None).
is not None).
"""
# set default variables based on the compass properties
Expand Down
6 changes: 3 additions & 3 deletions ladybug_display/extension/hourlyplot.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ def hourly_plot_to_vis_set(
(and an AnalysisGeometry). This includes these objects in the following order.
- Hour_Axis -- A ContextGeometry with lines and text for the hour-of-the-day
axis of the hourly plot.
axis of the hourly plot.
- Month_Axis -- A ContextGeometry with lines and text for the month-of-the-year
axis of the hourly plot.
axis of the hourly plot.
- Title -- A ContextGeometry with text for the title of the hourly plot.
This layer will be excluded if include_title is False.
This layer will be excluded if include_title is False.
- Analysis_Data -- An AnalysisGeometry for the data on the hourly plot.
"""
Expand Down
10 changes: 5 additions & 5 deletions ladybug_display/extension/monthlychart.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,19 @@ def monthly_chart_to_vis_set(
(and an AnalysisGeometry). This includes these objects in the following order.
- X_Axis -- A ContextGeometry with lines and text for the X axis of
the monthly chart.
the monthly chart.
- Y_Axis -- A ContextGeometry with lines and text for the Y axis of
the monthly chart.
the monthly chart.
- Y_Axis2 -- A ContextGeometry with lines and text for the second Y axis
of the monthly chart.
of the monthly chart.
- Title -- A ContextGeometry with text for the title of the monthly chart.
- Data_Outlines -- A ContextGeometry with a list of polylines that outline
the input data. These will represent the average or total at
each hour whenever the input data is hourly or monthly-per-hour data.
the input data. These will represent the average or total at
each hour whenever the input data is hourly or monthly-per-hour data.
- Analysis_Data -- An AnalysisGeometry for the data on the monthly chart.
"""
Expand Down
20 changes: 10 additions & 10 deletions ladybug_display/extension/psychchart.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,28 +38,28 @@ def psychrometric_chart_to_vis_set(
in the following order.
- Title -- A ContextGeometry for the title and border around the
psychrometric chart.
psychrometric chart.
- Temperature_Axis -- A ContextGeometry with lines and text for the
Temperature (X) axis of the psychrometric chart.
Temperature (X) axis of the psychrometric chart.
- Humidity_Axis -- A ContextGeometry with lines and text for the
Humidity (Y) axis of the psychrometric chart.
Humidity (Y) axis of the psychrometric chart.
- Relative_Humidity_Lines -- A ContextGeometry with lines and text
for the relative humidity of the psychrometric chart.
for the relative humidity of the psychrometric chart.
- Enthalpy_Lines -- A ContextGeometry with lines and text for the
enthalpy of the psychrometric chart. This layer will not be
included if plot_wet_bulb is True.
enthalpy of the psychrometric chart. This layer will not be
included if plot_wet_bulb is True.
- Wet_Bulb_Lines -- A ContextGeometry with lines and text for the wet bulb
temperature of the psychrometric chart. This layer will not be
included if plot_wet_bulb is False.
temperature of the psychrometric chart. This layer will not be
included if plot_wet_bulb is False.
- Analysis_Data -- An AnalysisGeometry for the data on the psychrometric
chart. This will include multiple data sets if the data input
is provided.
chart. This will include multiple data sets if the data input
is provided.
"""
# establish the VisualizationSet object
vis_set = VisualizationSet('Psychrometric_Chart', ())
Expand Down
4 changes: 2 additions & 2 deletions ladybug_display/extension/raddome.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ def radiation_dome_to_vis_set(radiation_dome, show_components=False, include_tit
- Compass -- A ContextGeometry for the Compass at the base of the dome.
- Max_Info -- A ContextGeometry with a Point and text for the maximum
radiation occurring on the dome.
radiation occurring on the dome.
- Title -- A ContextGeometry with text for the title of the dome.
This layer will be excluded if include_title is False.
This layer will be excluded if include_title is False.
- Radiation_Data -- An AnalysisGeometry for the radiation dome data.
"""
Expand Down
4 changes: 2 additions & 2 deletions ladybug_display/extension/radrose.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ def radiation_rose_to_vis_set(
- Compass -- A ContextGeometry for the Compass at the base of the rose.
- Orientation_Lines -- A ContextGeometry with lines representing the
edges (or "spokes") of the wind rose directions.
edges (or "spokes") of the wind rose directions.
- Title -- A ContextGeometry with text for the title of the rose.
This layer will be excluded if include_title is False.
This layer will be excluded if include_title is False.
- Radiation_Data -- An AnalysisGeometry for the radiation rose data.
"""
Expand Down
2 changes: 1 addition & 1 deletion ladybug_display/extension/skydome.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ def sky_dome_to_vis_set(sky_dome, show_components=False, include_title=True):
- Compass -- A ContextGeometry for the Compass at the base of the sky dome.
- Title -- A ContextGeometry with text for the title of the sky dome.
This layer will be excluded if include_title is False.
This layer will be excluded if include_title is False.
- Radiation_Data -- An AnalysisGeometry for the sky dome data.
"""
Expand Down
12 changes: 6 additions & 6 deletions ladybug_display/extension/sunpath.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ def sunpath_to_vis_set(
dome hemisphere to the 2D plane. If None, a 3D sun path will be drawn
instead of a 2D one. (Default: None) Choose from the following:
* Orthographic
* Stereographic
* Orthographic
* Stereographic
sun_spheres: Boolean to note whether sun positions should be drawn as points
or as fully-detailed spheres. Note that this option should only be
Expand All @@ -59,14 +59,14 @@ def sunpath_to_vis_set(
- Compass -- A ContextGeometry for the Compass at the base of the sunpath.
- Analemmas -- A ContextGeometry for the analemmas of the sunpath (if
the daily input is False).
the daily input is False).
- Daily_Arcs -- A ContextGeometry for the daily arcs across the sunpath.
- Sun_Positions -- Either a ContextGeometry or an AnalysisGeometry for
the sun positions (if hoys are input). The object will be an
AnalysisGeometry if data is input, indicating that suns are colored
with this data.
the sun positions (if hoys are input). The object will be an
AnalysisGeometry if data is input, indicating that suns are colored
with this data.
"""
# establish the VisualizationSet object
vis_set = VisualizationSet(
Expand Down
8 changes: 4 additions & 4 deletions ladybug_display/extension/windprofile.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,16 +56,16 @@ def wind_profile_to_vis_set(
and an AnalysisGeometry. This includes these objects in the following order.
- Arrows -- An AnalysisGeometry of colored mesh objects that represent
the wind speeds along the height of the wind profile.
the wind speeds along the height of the wind profile.
- Profile -- A Polyline outlining the wind speed as it changes
with height.
with height.
- Speed_Axis -- A ContextGeometry of line segments and text objects
that mark the X axis, which relates to the wind speed in (m/s).
that mark the X axis, which relates to the wind speed in (m/s).
- Height_Axis -- A ContextGeometry of line segments and text objects
that mark the Y axis, which relates to the the height above the ground.
that mark the Y axis, which relates to the the height above the ground.
"""
# establish the VisualizationSet object
vis_set = VisualizationSet(
Expand Down
4 changes: 2 additions & 2 deletions ladybug_display/extension/windrose.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ def wind_rose_to_vis_set(windrose, z=0, frequency_labels=True):
- Compass -- A ContextGeometry for the Compass at the base of the wind rose.
- Orientation_Lines -- A ContextGeometry with lines representing the
edges (or "spokes") of the wind rose directions.
edges (or "spokes") of the wind rose directions.
- Frequency_Lines -- A ContextGeometry with polygons representing
the frequency intervals of the wind rose.
the frequency intervals of the wind rose.
- Analysis_Data -- An AnalysisGeometry for the wind rose data.
"""
Expand Down

0 comments on commit 5eb9b8d

Please sign in to comment.