Skip to content

fix: minor documentation formatting issues #7469

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.

Sign up for GitHub

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

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

fix: minor documentation formatting issues #7469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1649b4
Small changes to JavaScript documentation formatting to help Python M…
gvwilson Jul 15, 2025
c4aee24
Update template_attributes.js
Lexachoc Dec 7, 2024
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
6 changes: 3 additions & 3 deletions src/components/annotations/attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ module.exports = templatedArray('annotation', {
description: [
'Sets the text associated with this annotation.',
'Plotly uses a subset of HTML tags to do things like',
'newline (<br>), bold (<b></b>), italics (<i></i>),',
'hyperlinks (<a href=\'...\'></a>). Tags <em>, <sup>, <sub>, <s>, <u>',
'<span> are also supported.'
'newline (`<br>`), bold (`<b></b>`), italics (`<i></i>`),',
'hyperlinks (`<a href=\'...\'></a>`). Tags `<em>`, `<sup>`,',
'`<sub>`, `<s>`, `<u>`, and `<span>` are also supported.'
].join(' ')
},
textangle: {
Expand Down
2 changes: 1 addition & 1 deletion src/components/errorbars/attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ module.exports = {
description: [
'Determines the rule used to generate the error bars.',

'If *constant`, the bar lengths are of a constant value.',
'If *constant*, the bar lengths are of a constant value.',
'Set this constant in `value`.',

'If *percent*, the bar lengths correspond to a percentage of',
Expand Down
2 changes: 1 addition & 1 deletion src/plots/template_attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ exports.hovertemplateAttrs = function(opts, extra) {
'The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data.',
'Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.',
descPart,
'Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>".',
'Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`.',
'To hide the secondary box completely, use an empty tag `<extra></extra>`.'
].join(' ')
};
Expand Down
4 changes: 2 additions & 2 deletions src/traces/contour/attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,11 +226,11 @@ module.exports = extendFlat({
'Sets the value or values of the constraint boundary.',

'When `operation` is set to one of the comparison values',
'(' + COMPARISON_OPS2 + ')',
'(`' + COMPARISON_OPS2 + '`)',
'*value* is expected to be a number.',

'When `operation` is set to one of the interval values',
'(' + INTERVAL_OPS + ')',
'(`' + INTERVAL_OPS + '`)',
'*value* is expected to be an array of two numbers where the first',
'is the lower bound and the second is the upper bound.',
].join(' ')
Expand Down