Skip to content
This repository was archived by the owner on Jun 3, 2024. It is now read-only.

Commit 802a9c0

Browse files
committed
capitalize some propTypes docstrings - and add one missing one
1 parent 970c682 commit 802a9c0

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

src/components/Graph.react.js

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -370,23 +370,23 @@ const graphPropTypes = {
370370
*/
371371
config: PropTypes.shape({
372372
/**
373-
* no interactivity, for export or image generation
373+
* No interactivity, for export or image generation
374374
*/
375375
staticPlot: PropTypes.bool,
376376

377377
/**
378-
* base URL for a Plotly cloud instance, if `showSendToCloud` is enabled
378+
* Base URL for a Plotly cloud instance, if `showSendToCloud` is enabled
379379
*/
380380
plotlyServerURL: PropTypes.string,
381381

382382
/**
383-
* we can edit titles, move annotations, etc - sets all pieces of `edits`
383+
* We can edit titles, move annotations, etc - sets all pieces of `edits`
384384
* unless a separate `edits` config item overrides individual parts
385385
*/
386386
editable: PropTypes.bool,
387387

388388
/**
389-
* a set of editable properties
389+
* A set of editable properties
390390
*/
391391
edits: PropTypes.shape({
392392
/**
@@ -397,7 +397,7 @@ const graphPropTypes = {
397397
annotationPosition: PropTypes.bool,
398398

399399
/**
400-
* just for annotations with arrows, change the length and direction of the arrow
400+
* Just for annotations with arrows, change the length and direction of the arrow
401401
*/
402402
annotationTail: PropTypes.bool,
403403

@@ -412,14 +412,14 @@ const graphPropTypes = {
412412
legendPosition: PropTypes.bool,
413413

414414
/**
415-
* edit the trace name fields from the legend
415+
* Edit the trace name fields from the legend
416416
*/
417417
legendText: PropTypes.bool,
418418

419419
shapePosition: PropTypes.bool,
420420

421421
/**
422-
* the global `layout.title`
422+
* The global `layout.title`
423423
*/
424424
titleText: PropTypes.bool,
425425
}),
@@ -436,27 +436,27 @@ const graphPropTypes = {
436436
responsive: PropTypes.bool,
437437

438438
/**
439-
* set the length of the undo/redo queue
439+
* Set the length of the undo/redo queue
440440
*/
441441
queueLength: PropTypes.number,
442442

443443
/**
444-
* if we DO autosize, do we fill the container or the screen?
444+
* If we DO autosize, do we fill the container or the screen?
445445
*/
446446
fillFrame: PropTypes.bool,
447447

448448
/**
449-
* if we DO autosize, set the frame margins in percents of plot size
449+
* If we DO autosize, set the frame margins in percents of plot size
450450
*/
451451
frameMargins: PropTypes.number,
452452

453453
/**
454-
* mousewheel or two-finger scroll zooms the plot
454+
* Mousewheel or two-finger scroll zooms the plot
455455
*/
456456
scrollZoom: PropTypes.bool,
457457

458458
/**
459-
* double click interaction (false, 'reset', 'autosize' or 'reset+autosize')
459+
* Double click interaction (false, 'reset', 'autosize' or 'reset+autosize')
460460
*/
461461
doubleClick: PropTypes.oneOf([
462462
false,
@@ -466,50 +466,50 @@ const graphPropTypes = {
466466
]),
467467

468468
/**
469-
* new users see some hints about interactivity
469+
* New users see some hints about interactivity
470470
*/
471471
showTips: PropTypes.bool,
472472

473473
/**
474-
* enable axis pan/zoom drag handles
474+
* Enable axis pan/zoom drag handles
475475
*/
476476
showAxisDragHandles: PropTypes.bool,
477477

478478
/**
479-
* enable direct range entry at the pan/zoom drag points
479+
* Enable direct range entry at the pan/zoom drag points
480480
* (drag handles must be enabled above)
481481
*/
482482
showAxisRangeEntryBoxes: PropTypes.bool,
483483

484484
/**
485-
* link to open this plot in plotly
485+
* Link to open this plot in plotly
486486
*/
487487
showLink: PropTypes.bool,
488488

489489
/**
490-
* if we show a link, does it contain data or just link to a plotly file?
490+
* If we show a link, does it contain data or just link to a plotly file?
491491
*/
492492
sendData: PropTypes.bool,
493493

494494
/**
495-
* text appearing in the sendData link
495+
* Text appearing in the sendData link
496496
*/
497497
linkText: PropTypes.string,
498498

499499
/**
500-
* display the mode bar (true, false, or 'hover')
500+
* Display the mode bar (true, false, or 'hover')
501501
*/
502502
displayModeBar: PropTypes.oneOf([true, false, 'hover']),
503503

504504
/**
505-
* should we include a modebar button to send this data to a
505+
* Should we include a modebar button to send this data to a
506506
* Plotly Cloud instance, linked by `plotlyServerURL`.
507507
* By default this is false.
508508
*/
509509
showSendToCloud: PropTypes.bool,
510510

511511
/**
512-
* remove mode bar button by name.
512+
* Remove mode bar button by name.
513513
* All modebar button names at https://github.com/plotly/plotly.js/blob/master/src/components/modebar/buttons.js
514514
* Common names include:
515515
* - sendDataToCloud
@@ -522,19 +522,19 @@ const graphPropTypes = {
522522
modeBarButtonsToRemove: PropTypes.array,
523523

524524
/**
525-
* add mode bar button using config objects
525+
* Add mode bar button using config objects
526526
*/
527527
modeBarButtonsToAdd: PropTypes.array,
528528

529529
/**
530-
* fully custom mode bar buttons as nested array,
530+
* Fully custom mode bar buttons as nested array,
531531
* where the outer arrays represents button groups, and
532532
* the inner arrays have buttons config objects or names of default buttons
533533
*/
534534
modeBarButtons: PropTypes.any,
535535

536536
/**
537-
*
537+
* Modifications to how the toImage modebar button works
538538
*/
539539
toImageButtonOptions: PropTypes.shape({
540540
/**
@@ -561,17 +561,17 @@ const graphPropTypes = {
561561
}),
562562

563563
/**
564-
* add the plotly logo on the end of the mode bar
564+
* Add the plotly logo on the end of the mode bar
565565
*/
566566
displaylogo: PropTypes.bool,
567567

568568
/**
569-
* add the plotly logo even with no modebar
569+
* Add the plotly logo even with no modebar
570570
*/
571571
watermark: PropTypes.bool,
572572

573573
/**
574-
* increase the pixel ratio for Gl plot images
574+
* Increase the pixel ratio for Gl plot images
575575
*/
576576
plotGlPixelRatio: PropTypes.number,
577577

0 commit comments

Comments
 (0)