Commit 0f9b311

daexsgvwilson

authored and

committed

Fixed markdown formatting for valType 'info_array'

All three cases in 'InfoArrayValidator' no longer encounter '[][]' errors. For examples, see '_node.py' groups property, '_image.py' zmax property, '_dimension.py' constraintrange property. Keep the newline between "...specified as" and "* ..." to avoid rendering a code block. Note: Python now raises a SyntaxWarning due to '\['.

1 parent c2e20c7 commit 0f9b311Copy full SHA for 0f9b311

File tree

1 file changed

+12

-13

lines changed

_plotly_utils
- basevalidators.py

1 file changed

+12

-13

lines changed

`‎_plotly_utils/basevalidators.py`

Lines changed: 12 additions & 13 deletions

Original file line number	Diff line number	Diff line change
`@@ -716,15 +716,15 @@ def __init__(`
`716`	`716`
`717`	`717`	`def description(self):`
`718`	`718`	`desc = """\`
`719`		`- The '{plotly_name}' property is a number and may be specified as:""".format(`
	`719`	`+ The '{plotly_name}' property is a number and may be specified as:""".format(`
`720`	`720`	`plotly_name=self.plotly_name`
`721`	`721`	`)`
`722`	`722`
`723`	`723`	`if not self.has_min_max:`
`724`	`724`	`desc = (`
`725`	`725`	`desc`
`726`		`- + """`
`727`		`- - An int or float"""`
	`726`	`+ + """\n`
	`727`	`+ - An int or float"""`
`728`	`728`	`)`
`729`	`729`
`730`	`730`	`else:`
`@@ -1983,17 +1983,16 @@ def description(self):`
`1983`	`1983`	`# ### Case 1 ###`
`1984`	`1984`	`if self.dimensions in (1, "1-2"):`
`1985`	`1985`	`upto = " up to" if self.free_length and self.dimensions == 1 else ""`
`1986`		`- desc += """`
`1987`		`-`
	`1986`	`+ desc += """\n`
`1988`	`1987`	`* a list or tuple of{upto} {N} elements where:\`
`1989`	`1988`	`""".format(upto=upto, N=len(self.item_validators))`
`1990`	`1989`
`1991`	`1990`	`for i, item_validator in enumerate(self.item_validators):`
`1992`	`1991`	`el_desc = item_validator.description().strip()`
`1993`	`1992`	`desc = (`
`1994`	`1993`	`desc`
`1995`		`- + """`
`1996`		`-({i}) {el_desc}""".format(i=i, el_desc=el_desc)`
	`1994`	`+ + """\n`
	`1995`	`+({i}) {el_desc}""".format(i=i, el_desc=el_desc)`
`1997`	`1996`	`)`
`1998`	`1997`
`1999`	`1998`	`# ### Case 2 ###`
`@@ -2006,15 +2005,15 @@ def description(self):`
`2006`	`2005`	`for i, item_validator in enumerate(self.item_validators):`
`2007`	`2006`	`# Update name for 2d`
`2008`	`2007`	`orig_name = item_validator.plotly_name`
`2009`		`- item_validator.plotly_name = "{name}[i][{i}]".format(`
	`2008`	`+ item_validator.plotly_name = "{name}\\[i\\]\\[{i}\\]".format(`
`2010`	`2009`	`name=self.plotly_name, i=i`
`2011`	`2010`	`)`
`2012`	`2011`
`2013`	`2012`	`el_desc = item_validator.description().strip()`
`2014`	`2013`	`desc = (`
`2015`	`2014`	`desc`
`2016`		`- + """`
`2017`		`-({i}) {el_desc}""".format(i=i, el_desc=el_desc)`
	`2015`	`+ + """\n`
	`2016`	`+({i}) {el_desc}""".format(i=i, el_desc=el_desc)`
`2018`	`2017`	`)`
`2019`	`2018`	`item_validator.plotly_name = orig_name`
`2020`	`2019`	`else:`
`@@ -2039,9 +2038,9 @@ def description(self):`
`2039`	`2038`	`)`
`2040`	`2039`
`2041`	`2040`	`el_desc = item_validator.description().strip()`
`2042`		`- desc += """`
`2043`		`- * a 2D list where:`
`2044`		`- {el_desc}`
	`2041`	`+ desc += """\n`
	`2042`	`+ * a 2D list where:\n`
	`2043`	`+ {el_desc}`
`2045`	`2044`	`""".format(el_desc=el_desc)`
`2046`	`2045`
`2047`	`2046`	`item_validator.plotly_name = orig_name`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit 0f9b311

File tree

1 file changed

1 file changed

`‎_plotly_utils/basevalidators.py`

0 commit comments