Skip to content

Commit

Permalink
DOC: Use API path for plotnine in see also
Browse files Browse the repository at this point in the history
  • Loading branch information
has2k1 committed Feb 24, 2024
1 parent 4323c53 commit bb7b00d
Show file tree
Hide file tree
Showing 31 changed files with 43 additions and 43 deletions.
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_area.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class geom_area(geom_ribbon):
See Also
--------
plotnine.geoms.geom_ribbon
plotnine.geom_ribbon
"""

REQUIRED_AES = {"x", "y"}
Expand Down
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_bar.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class geom_bar(geom_rect):
See Also
--------
plotnine.geoms.geom_histogram
plotnine.geom_histogram
"""

REQUIRED_AES = {"x", "y"}
Expand Down
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_col.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class geom_col(geom_bar):
See Also
--------
plotnine.geoms.geom_bar
plotnine.geom_bar
"""

REQUIRED_AES = {"x", "y"}
Expand Down
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_density.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class geom_density(geom_area):
See Also
--------
plotnine.geoms.geom_ribbon
plotnine.geom_ribbon
"""

DEFAULT_AES = {
Expand Down
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_dotplot.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ class geom_dotplot(geom):
See Also
--------
plotnine.stats.stat_bindot
plotnine.stat_bindot
"""

DEFAULT_AES = {"alpha": 1, "color": "black", "fill": "black"}
Expand Down
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_histogram.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class geom_histogram(geom_bar):
See Also
--------
plotnine.geoms.geom_bar
plotnine.geom_bar
"""

DEFAULT_PARAMS = {"stat": "bin", "position": "stack", "na_rm": False}
4 changes: 2 additions & 2 deletions plotnine/geoms/geom_jitter.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ class geom_jitter(geom_point):
See Also
--------
plotnine.positions.position_jitter
plotnine.geoms.geom_point
plotnine.position_jitter
plotnine.geom_point
"""

DEFAULT_PARAMS = {
Expand Down
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_label.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ class geom_label(geom_text):
See Also
--------
plotnine.geoms.geom_text : For documentation of the
plotnine.geom_text : For documentation of the
parameters. [](`~matplotlib.patches.BoxStyle`) for the
parameters that affect the boxstyle.
"""
Expand Down
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_line.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class geom_line(geom_path):
See Also
--------
plotnine.geoms.geom_path : For documentation of other parameters.
plotnine.geom_path : For documentation of other parameters.
"""

def setup_data(self, data: pd.DataFrame) -> pd.DataFrame:
Expand Down
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_path.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ class geom_path(geom):
See Also
--------
plotnine.geoms.geom_path.arrow : for adding arrowhead(s) to paths.
plotnine.arrow : for adding arrowhead(s) to paths.
"""

DEFAULT_AES = {
Expand Down
4 changes: 2 additions & 2 deletions plotnine/geoms/geom_raster.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ class geom_raster(geom):
See Also
--------
plotnine.geoms.geom_rect
plotnine.geoms.geom_tile
plotnine.geom_rect
plotnine.geom_tile
"""

DEFAULT_AES = {"alpha": 1, "fill": "#333333"}
Expand Down
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_segment.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ class geom_segment(geom):
See Also
--------
plotnine.geoms.geom_path.arrow : for adding arrowhead(s) to segments.
plotnine.arrow : for adding arrowhead(s) to segments.
"""

DEFAULT_AES = {
Expand Down
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_sina.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class geom_sina(geom_point):
See Also
--------
plotnine.stats.stat_sina
plotnine.stat_sina
References
----------
Expand Down
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_spoke.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class geom_spoke(geom_segment):
See Also
--------
plotnine.geoms.geom_segment : For documentation of extra
plotnine.geom_segment : For documentation of extra
parameters.
"""

Expand Down
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_step.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class geom_step(geom_path):
See Also
--------
plotnine.geoms.geom_path : For documentation of extra parameters.
plotnine.geom_path : For documentation of extra parameters.
"""

DEFAULT_PARAMS = {
Expand Down
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_text.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ class geom_text(geom):
See Also
--------
plotnine.geoms.geom_label
plotnine.geom_label
matplotlib.text.Text
matplotlib.patheffects
Expand Down
2 changes: 1 addition & 1 deletion plotnine/geoms/geom_tile.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class geom_tile(geom_rect):
See Also
--------
plotnine.geoms.geom_rect
plotnine.geom_rect
"""

DEFAULT_AES = {
Expand Down
6 changes: 3 additions & 3 deletions plotnine/mapping/aes.py
Original file line number Diff line number Diff line change
Expand Up @@ -202,11 +202,11 @@ class aes(Dict[str, Any]):
See Also
--------
plotnine.mapping.after_stat : For how to map aesthetics to variable
plotnine.after_stat : For how to map aesthetics to variable
calculated by the stat
plotnine.mapping.after_scale : For how to alter aesthetics after the
plotnine.after_scale : For how to alter aesthetics after the
data has been mapped by the scale.
plotnine.mapping.stage : For how to map to evaluate the mapping to
plotnine.stage : For how to map to evaluate the mapping to
aesthetics at more than one stage of the plot building pipeline.
"""

Expand Down
8 changes: 4 additions & 4 deletions plotnine/mapping/evaluation.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ def after_stat(x):
See Also
--------
plotnine.mapping.after_scale
plotnine.mapping.stage
plotnine.after_scale
plotnine.stage
"""
return stage(after_stat=x)

Expand All @@ -102,8 +102,8 @@ def after_scale(x):
See Also
--------
plotnine.mapping.after_stat
plotnine.mapping.stage
plotnine.after_stat
plotnine.stage
"""
return stage(after_scale=x)

Expand Down
2 changes: 1 addition & 1 deletion plotnine/positions/position.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ def compute_panel(
See Also
--------
position_jitter.compute_panel
plotnine.position_jitter.compute_panel
"""
msg = "{} needs to implement this method"
raise NotImplementedError(msg.format(cls.__name__))
Expand Down
12 changes: 6 additions & 6 deletions plotnine/scales/scale_color.py
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@ class scale_color_gradient(scale_continuous):
See Also
--------
plotnine.scales.scale_color_gradient2
plotnine.scales.scale_color_gradientn
plotnine.scale_color_gradient2
plotnine.scale_color_gradientn
"""

_aesthetics = ["color"]
Expand Down Expand Up @@ -277,8 +277,8 @@ class scale_color_gradient2(scale_continuous):
See Also
--------
plotnine.scales.scale_color_gradient
plotnine.scales.scale_color_gradientn
plotnine.scale_color_gradient
plotnine.scale_color_gradientn
"""

_aesthetics = ["color"]
Expand Down Expand Up @@ -338,8 +338,8 @@ class scale_color_gradientn(scale_continuous):
See Also
--------
plotnine.scales.scale_color_gradient
plotnine.scales.scale_color_gradientn
plotnine.scale_color_gradient
plotnine.scale_color_gradientn
"""

_aesthetics = ["color"]
Expand Down
2 changes: 1 addition & 1 deletion plotnine/stats/stat_bindot.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ class stat_bindot(stat):
See Also
--------
plotnine.stats.stat_bin
plotnine.stat_bin
"""

_aesthetics_doc = """
Expand Down
2 changes: 1 addition & 1 deletion plotnine/stats/stat_boxplot.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class stat_boxplot(stat):
See Also
--------
plotnine.geoms.geom_boxplot
plotnine.geom_boxplot
"""

_aesthetics_doc = """
Expand Down
2 changes: 1 addition & 1 deletion plotnine/stats/stat_count.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class stat_count(stat):
See Also
--------
plotnine.stats.stat_bin
plotnine.stat_bin
"""

_aesthetics_doc = """
Expand Down
2 changes: 1 addition & 1 deletion plotnine/stats/stat_density.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ class stat_density(stat):
See Also
--------
plotnine.geoms.geom_density
plotnine.geom_density
statsmodels.nonparametric.kde.KDEUnivariate
statsmodels.nonparametric.kde.KDEUnivariate.fit
"""
Expand Down
2 changes: 1 addition & 1 deletion plotnine/stats/stat_ecdf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class stat_ecdf(stat):
See Also
--------
plotnine.geoms.geom_step
plotnine.geom_step
"""

_aesthetics_doc = """
Expand Down
2 changes: 1 addition & 1 deletion plotnine/stats/stat_quantile.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class stat_quantile(stat):
See Also
--------
statsmodels.regression.quantile_regression.QuantReg
plotnine.geoms.geom_quantile
plotnine.geom_quantile
"""

_aesthetics_doc = """
Expand Down
2 changes: 1 addition & 1 deletion plotnine/stats/stat_sina.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ class stat_sina(stat):
See Also
--------
plotnine.geoms.geom_sina
plotnine.geom_sina
"""

_aesthetics_doc = """
Expand Down
2 changes: 1 addition & 1 deletion plotnine/stats/stat_summary.py
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ class stat_summary(stat):
See Also
--------
plotnine.geoms.geom_pointrange
plotnine.geom_pointrange
"""

_aesthetics_doc = """
Expand Down
2 changes: 1 addition & 1 deletion plotnine/stats/stat_summary_bin.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class stat_summary_bin(stat):
See Also
--------
plotnine.geoms.geom_pointrange
plotnine.geom_pointrange
"""

_aesthetics_doc = """
Expand Down
2 changes: 1 addition & 1 deletion plotnine/stats/stat_ydensity.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ class stat_ydensity(stat):
See Also
--------
plotnine.geoms.geom_violin
plotnine.geom_violin
statsmodels.nonparametric.kde.KDEUnivariate
statsmodels.nonparametric.kde.KDEUnivariate.fit
"""
Expand Down

0 comments on commit bb7b00d

Please sign in to comment.