Skip to content

Commit 38374ac

Browse files
authored
Merge pull request #5822 from plotly/update-de-links
Docs: Update DE links and capitalization consistency in headings
2 parents 276e164 + d9db2f5 commit 38374ac

44 files changed

Lines changed: 119 additions & 119 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎doc/python/3d-mesh.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jupyter:
3333
thumbnail: thumbnail/3d-mesh.jpg
3434
---
3535

36-
### Simple 3D Mesh example ###
36+
### Simple 3D Mesh Example
3737

3838
`go.Mesh3d` draws a 3D set of triangles with vertices given by `x`, `y` and `z`. If only coordinates are given, an algorithm such as [Delaunay triangulation](https://en.wikipedia.org/wiki/Delaunay_triangulation) is used to draw the triangles. Otherwise the triangles can be given using the `i`, `j` and `k` parameters (see examples below).
3939

@@ -49,7 +49,7 @@ fig = go.Figure(data=[go.Mesh3d(x=x, y=y, z=z, color='lightpink', opacity=0.50)]
4949
fig.show()
5050
```
5151

52-
### 3D Mesh example with Alphahull
52+
### 3D Mesh Example with Alphahull
5353

5454

5555
The `alphahull` parameter sets the shape of the mesh. If the value is -1 (default value) then [Delaunay triangulation](https://en.wikipedia.org/wiki/Delaunay_triangulation) is used. If >0 then the [alpha-shape algorithm](https://en.wikipedia.org/wiki/Alpha_shape) is used. If 0, the [convex hull](https://en.wikipedia.org/wiki/Convex_hull) is represented (resulting in a convex body).
@@ -72,7 +72,7 @@ fig.show()
7272

7373
[Dash](https://plotly.com/dash/) is the best way to build analytical apps in Python using Plotly figures. To run the app below, run `pip install dash`, click "Download" to get the code and run `python app.py`.
7474

75-
Get started with [the official Dash docs](https://dash.plotly.com/installation) and **learn how to effortlessly [style](https://plotly.com/dash/design-kit/) & publish apps like this with <a class="plotly-red" href="https://plotly.com/dash/">Dash Enterprise</a> or <a class="plotly-red" href="https://plotly.com/cloud/">Plotly Cloud</a>.**
75+
Get started with [the official Dash docs](https://dash.plotly.com/installation) and **learn how to effortlessly [style](https://plotly.com/dash/design-kit/) & publish apps like this with <a class="plotly-red" href="https://plotly.com/dash-enterprise/">Dash Enterprise</a> or <a class="plotly-red" href="https://plotly.com/cloud/">Plotly Cloud</a>.**
7676

7777

7878
```python hide_code=true
@@ -146,7 +146,7 @@ fig = go.Figure(data=[
146146
fig.show()
147147
```
148148

149-
### Intensity values defined on vertices or cells
149+
### Intensity Values Defined on Vertices or Cells
150150

151151
The `intensitymode` attribute of `go.Mesh3d` can be set to `vertex` (default mode, in which case intensity values are interpolated between values defined on vertices), or to `cell` (value of the whole cell, no interpolation). Note that the `intensity` parameter should have the same length as the number of vertices or cells, depending on the `intensitymode`.
152152

‎doc/python/3d-scatter-plots.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jupyter:
3333
thumbnail: thumbnail/3d-scatter.jpg
3434
---
3535

36-
## 3D scatter plot with Plotly Express
36+
## 3D Scatter Plot with Plotly Express
3737

3838
[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on a variety of types of data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/).
3939

@@ -57,7 +57,7 @@ fig = px.scatter_3d(df, x='sepal_length', y='sepal_width', z='petal_width',
5757
fig.show()
5858
```
5959

60-
#### Style 3d scatter plot
60+
#### Style 3D Scatter Plot
6161

6262
It is possible to customize the style of the figure through the parameters of `px.scatter_3d` for some options, or by updating the traces or the layout of the figure through `fig.update`.
6363

@@ -73,11 +73,11 @@ fig.update_layout(margin=dict(l=0, r=0, b=0, t=0))
7373
fig.show()
7474
```
7575

76-
#### 3d scatter plots in Dash
76+
#### 3D Scatter Plots in Dash
7777

7878
[Dash](https://plotly.com/dash/) is the best way to build analytical apps in Python using Plotly figures. To run the app below, run `pip install dash`, click "Download" to get the code and run `python app.py`.
7979

80-
Get started with [the official Dash docs](https://dash.plotly.com/installation) and **learn how to effortlessly [style](https://plotly.com/dash/design-kit/) & publish apps like this with <a class="plotly-red" href="https://plotly.com/dash/">Dash Enterprise</a> or <a class="plotly-red" href="https://plotly.com/cloud/">Plotly Cloud</a>.**
80+
Get started with [the official Dash docs](https://dash.plotly.com/installation) and **learn how to effortlessly [style](https://plotly.com/dash/design-kit/) & publish apps like this with <a class="plotly-red" href="https://plotly.com/dash-enterprise/">Dash Enterprise</a> or <a class="plotly-red" href="https://plotly.com/cloud/">Plotly Cloud</a>.**
8181

8282

8383
```python hide_code=true

‎doc/python/animations.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ jupyter:
3434
thumbnail: thumbnail/animations.gif
3535
---
3636

37-
#### Animated figures with Plotly Express
37+
#### Animated Figures with Plotly Express
3838

3939
Several [Plotly Express](/python/plotly-express/) functions support the creation of animated figures through the `animation_frame` and `animation_group` arguments.
4040

@@ -48,11 +48,11 @@ px.scatter(df, x="gdpPercap", y="lifeExp", animation_frame="year", animation_gro
4848
log_x=True, size_max=55, range_x=[100,100000], range_y=[25,90])
4949
```
5050

51-
#### Animated figures in Dash
51+
#### Animated Figures in Dash
5252

5353
[Dash](https://plotly.com/dash/) is the best way to build analytical apps in Python using Plotly figures. To run the app below, run `pip install dash`, click "Download" to get the code and run `python app.py`.
5454

55-
Get started with [the official Dash docs](https://dash.plotly.com/installation) and **learn how to effortlessly [style](https://plotly.com/dash/design-kit/) & publish apps like this with <a class="plotly-red" href="https://plotly.com/dash/">Dash Enterprise</a> or <a class="plotly-red" href="https://plotly.com/cloud/">Plotly Cloud</a>.**
55+
Get started with [the official Dash docs](https://dash.plotly.com/installation) and **learn how to effortlessly [style](https://plotly.com/dash/design-kit/) & publish apps like this with <a class="plotly-red" href="https://plotly.com/dash-enterprise/">Dash Enterprise</a> or <a class="plotly-red" href="https://plotly.com/cloud/">Plotly Cloud</a>.**
5656

5757

5858
```python hide_code=true
@@ -81,7 +81,7 @@ fig.show()
8181
* Although Plotly Express supports animation for many chart and map types, smooth inter-frame transitions are today *only* possible for `scatter` and `bar`
8282
* Plotly Express will *not* automatically compute the union of all x/y/color ranges, so these must be specified manually to avoid scale jumps across frames
8383

84-
#### Animated figures with Graph Objects
84+
#### Animated Figures with Graph Objects
8585

8686
The remainder of this section describes the low-level [graph objects](/python/graph-objects/) API for constructing animated figures manually.
8787

‎doc/python/axes.md‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The axis type is auto-detected by looking at data from the first [trace](/python
6464
* Both of these test an evenly-spaced sample of at most 1000 values
6565

6666

67-
### Forcing an axis to be categorical
67+
### Forcing an Axis to be Categorical
6868

6969
It is possible to force the axis type by setting explicitly `xaxis_type`. In the example below the automatic X axis type would be `linear` (because there are not more than twice as many unique strings as unique numbers) but we force it to be `category`.
7070

@@ -91,7 +91,7 @@ The examples on this page apply to axes of any type, but extra attributes are av
9191

9292
#### Set and Style Axes Title Labels
9393

94-
##### Set axis title text with Plotly Express
94+
##### Set Axis Title Text with Plotly Express
9595

9696
Axis titles are automatically set to the column names when [using Plotly Express with a data frame as input](/python/px-arguments/).
9797

@@ -124,11 +124,11 @@ fig = px.bar(x=["Apples", "Oranges"], y=[10,20], color=["Here", "There"],
124124
fig.show()
125125
```
126126

127-
##### Rotating tick labels in Dash
127+
##### Rotating Tick Labels in Dash
128128

129129
[Dash](https://plotly.com/dash/) is the best way to build analytical apps in Python using Plotly figures. To run the app below, run `pip install dash`, click "Download" to get the code and run `python app.py`.
130130

131-
Get started with [the official Dash docs](https://dash.plotly.com/installation) and **learn how to effortlessly [style](https://plotly.com/dash/design-kit/) & publish apps like this with <a class="plotly-red" href="https://plotly.com/dash/">Dash Enterprise</a> or <a class="plotly-red" href="https://plotly.com/cloud/">Plotly Cloud</a>.**
131+
Get started with [the official Dash docs](https://dash.plotly.com/installation) and **learn how to effortlessly [style](https://plotly.com/dash/design-kit/) & publish apps like this with <a class="plotly-red" href="https://plotly.com/dash-enterprise/">Dash Enterprise</a> or <a class="plotly-red" href="https://plotly.com/cloud/">Plotly Cloud</a>.**
132132

133133

134134
```python hide_code=true
@@ -173,7 +173,7 @@ fig.update_xaxes(labelalias=dict(Sat="Saturday", Sun="Sunday"))
173173
fig.show()
174174
```
175175

176-
##### Set axis title text with Graph Objects
176+
##### Set Axis Title Text with Graph Objects
177177

178178
Axis titles are set using the nested `title.text` property of the x or y axis. Here is an example of creating a new figure and using `update_xaxes` and `update_yaxes`, with magic underscore notation, to set the axis titles.
179179

@@ -188,7 +188,7 @@ fig.update_yaxes(title_text='Value A')
188188
fig.show()
189189
```
190190

191-
### Set axis title position
191+
### Set Axis Title Position
192192

193193
This example sets `standoff` attribute to cartesian axes to determine the distance between the tick labels and the axis title. Note that the axis title position is always constrained within the margins, so the actual standoff distance is always less than the set or default value. By default [automargin](https://plotly.com/python/setting-graph-size/#automatically-adjust-margins) is `True` in Plotly template for the cartesian axis, so the margins will be pushed to fit the axis title at given standoff distance.
194194

@@ -213,7 +213,7 @@ fig.update_yaxes(
213213
fig.show()
214214
```
215215

216-
##### Set axis title font
216+
##### Set Axis Title Font
217217

218218
Here is an example that configures the font family, size, and color for the axis titles in a figure created using Plotly Express.
219219

@@ -230,7 +230,7 @@ fig.show()
230230

231231
#### Tick Placement, Color, and Style
232232

233-
##### Toggling axis tick marks
233+
##### Toggling Axis Tick Marks
234234

235235
Axis tick marks are disabled by default for the default `plotly` theme, but they can easily be turned on by setting the `ticks` axis property to `"inside"` (to place ticks inside plotting area) or `"outside"` (to place ticks outside the plotting area).
236236

@@ -247,7 +247,7 @@ fig.update_yaxes(ticks="inside", col=1)
247247
fig.show()
248248
```
249249

250-
##### Set number of tick marks (and grid lines)
250+
##### Set Number of Tick Marks (and Grid Lines)
251251

252252
The approximate number of ticks displayed for an axis can be specified using the `nticks` axis property.
253253

@@ -263,7 +263,7 @@ fig.update_yaxes(nticks=20)
263263
fig.show()
264264
```
265265

266-
##### Set start position and distance between ticks
266+
##### Set Start Position and Distance Between Ticks
267267

268268
The `tick0` and `dtick` axis properties can be used to control to placement of axis ticks as follows: If specified, a tick will fall exactly on the location of `tick0` and additional ticks will be added in both directions at intervals of `dtick`.
269269

@@ -279,7 +279,7 @@ fig.update_yaxes(tick0=0.25, dtick=0.5)
279279
fig.show()
280280
```
281281

282-
##### Set exact location of axis ticks
282+
##### Set Exact Location of Axis Ticks
283283

284284
It is possible to configure an axis to display ticks at a set of predefined locations by setting the `tickvals` property to an array of positions.
285285

@@ -295,7 +295,7 @@ fig.update_yaxes(tickvals=[5.1, 5.9, 6.3, 7.5])
295295
fig.show()
296296
```
297297

298-
##### Style tick marks
298+
##### Style Tick Marks
299299

300300
As discussed above, tick marks are disabled by default in the default `plotly` theme, but they can be enabled by setting the `ticks` axis property to `"inside"` (to place ticks inside plotting area) or `"outside"` (to place ticks outside the plotting area).
301301

@@ -314,7 +314,7 @@ fig.update_yaxes(ticks="outside", tickwidth=2, tickcolor='crimson', ticklen=10,
314314
fig.show()
315315
```
316316

317-
##### Step for tick labels
317+
##### Step for Tick Labels
318318

319319
*New in v5.6*
320320

@@ -330,7 +330,7 @@ fig.update_yaxes(ticklabelstep=2)
330330
fig.show()
331331
```
332332

333-
##### Toggling axis labels
333+
##### Toggling Axis Labels
334334

335335
The axis tick mark labels can be disabled by setting the `showticklabels` axis property to `False`.
336336

@@ -347,7 +347,7 @@ fig.update_yaxes(showticklabels=False)
347347
fig.show()
348348
```
349349

350-
##### Set axis label rotation and font
350+
##### Set Axis Label Rotation and Font
351351

352352
The orientation of the axis tick mark labels is configured using the `tickangle` axis property. The value of `tickangle` is the angle of rotation, in the clockwise direction, of the labels from vertical in units of degrees. The font family, size, and color for the tick labels are stored under the `tickfont` axis property.
353353

@@ -426,7 +426,7 @@ fig.update_layout(title_text="Apple Stock Price")
426426
fig.show()
427427
```
428428

429-
#### Adding minor ticks
429+
#### Adding Minor Ticks
430430

431431
_new in 5.8_
432432

@@ -506,9 +506,9 @@ fig.update_layout(
506506
fig.show()
507507
```
508508

509-
### Axis lines: grid and zerolines
509+
### Axis Lines: Grid and Zero Lines
510510

511-
##### Toggling Axis grid lines
511+
##### Toggling Axis Grid Lines
512512

513513
Axis grid lines can be disabled by setting the `showgrid` property to `False` for the x and/or y axis.
514514

@@ -523,7 +523,7 @@ fig.update_yaxes(showgrid=False)
523523
fig.show()
524524
```
525525

526-
##### Toggling Axis zero lines
526+
##### Toggling Axis Zero Lines
527527

528528
The lines passing through zero can be disabled as well by setting the `zeroline` axis property to `False`
529529

@@ -537,9 +537,9 @@ fig.update_yaxes(showgrid=False, zeroline=False)
537537
fig.show()
538538
```
539539

540-
#### Styling and Coloring Axes and the Zero-Line
540+
#### Styling and Coloring Axes and the Zero Line
541541

542-
##### Styling axis lines
542+
##### Styling Axis Lines
543543

544544
The `showline` axis property controls the visibility of the axis line, and the `linecolor` and `linewidth` axis properties control the color and width of the axis line.
545545

@@ -556,7 +556,7 @@ fig.update_yaxes(showline=True, linewidth=2, linecolor='black')
556556
fig.show()
557557
```
558558

559-
##### Mirroring axis lines
559+
##### Mirroring Axis Lines
560560

561561
Axis lines can be mirrored to the opposite side of the plotting area by setting the `mirror` axis property to `True`.
562562

@@ -573,7 +573,7 @@ fig.update_yaxes(showline=True, linewidth=2, linecolor='black', mirror=True)
573573
fig.show()
574574
```
575575

576-
##### Styling grid lines
576+
##### Styling Grid Lines
577577

578578
The width and color of axis grid lines are controlled by the `gridwidth` and `gridcolor` axis properties.
579579

@@ -604,7 +604,7 @@ fig.update_xaxes(gridcolor='black', griddash='dash', minor_griddash="dot")
604604
fig.show()
605605
```
606606

607-
##### Styling zero lines
607+
##### Styling Zero Lines
608608

609609
The width and color of axis zero lines are controlled by the `zerolinewidth` and `zerolinecolor` axis properties.
610610

@@ -689,7 +689,7 @@ fig.update_xaxes(insiderange=['2018-10-01', '2019-01-01'], title=dict(text="Date
689689
fig.show()
690690
```
691691

692-
#### Setting only a Lower or Upper Bound for Range
692+
#### Setting Only a Lower or Upper Bound for Range
693693

694694
*New in 5.17*
695695

@@ -767,7 +767,7 @@ fig.update_yaxes(
767767
fig.show()
768768
```
769769

770-
### Fixed Ratio Axes with Compressed domain
770+
### Fixed Ratio Axes with Compressed Domain
771771

772772
If an axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), `constrain` determines how that happens: by increasing the "range" (default), or by decreasing the "domain".
773773

@@ -794,7 +794,7 @@ fig.update_yaxes(
794794
fig.show()
795795
```
796796

797-
##### Decreasing the domain spanned by an axis
797+
##### Decreasing the Domain Spanned by an Axis
798798

799799
In the example below, the x and y axis are anchored together, and the range of the `xaxis` is set manually. By default, plotly extends the range of the axis (overriding the `range` parameter) to fit in the figure `domain`. You can restrict the `domain` to force the axis to span only the set range, by setting `constrain='domain'` as below.
800800

@@ -842,7 +842,7 @@ fig.update_yaxes(autorange="reversed")
842842
fig.show()
843843
```
844844

845-
#### Reversed Axes with Range ( Min/Max ) Specified
845+
#### Reversed Axes with Range (Min/Max) Specified
846846

847847
The direction of an axis can be reversed when manually setting the range extents by specifying a list containing the upper bound followed by the lower bound (rather that the lower followed by the upper) as the `range` axis property.
848848

@@ -888,7 +888,7 @@ fig.update_yaxes(range=[None, 3], autorange="max reversed")
888888
fig.show()
889889
```
890890

891-
### Axis range for log axis type
891+
### Axis Range for Log Axis Type
892892

893893
If you are using a `log` type of axis and you want to set the range of the axis, you have to give the `log10` value of the bounds when using `fig.update_xaxes` or `fig.update_layout`. However, with `plotly.express` functions you pass directly the values of the range bounds (`plotly.express` then computes the appropriate values to pass to the figure layout).
894894

@@ -928,7 +928,7 @@ fig.update_yaxes(domain=(0.25, 0.75))
928928
fig.show()
929929
```
930930

931-
#### Synchronizing axes in subplots with `matches`
931+
#### Synchronizing Axes in Subplots with `matches`
932932

933933
Using `facet_col` from `plotly.express` let [zoom](https://help.plotly.com/zoom-pan-hover-controls/#step-3-zoom-in-and-zoom-out-autoscale-the-plot) and [pan](https://help.plotly.com/zoom-pan-hover-controls/#step-6-pan-along-axes) each facet to the same range implicitly. However, if the subplots are created with `make_subplots`, the axis needs to be updated with `matches` parameter to update all the subplots accordingly.
934934

@@ -1008,7 +1008,7 @@ fig.update_xaxes(autorangeoptions=dict(clipmax=4))
10081008
fig.show()
10091009
```
10101010

1011-
##### Specify Values to be Included
1011+
##### Specify Values to Be Included
10121012

10131013
Use `autorangeoptions.include` to specify a value that should always be included within the calculated autorange. In this example, we specify that for the autorange calculated on the x-axis, 5 should be included.
10141014

0 commit comments

Comments
 (0)