Commit29f2e5c

committed

add documentation about use of axis('equal') in pzmap, rlocus

1 parent8356044 commit29f2e5cCopy full SHA for 29f2e5c

File tree

+17

-2

lines changed

+17

-2

lines changed

Lines changed: 9 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -59,8 +59,7 @@`
`59`	`59`	`# http://matplotlib.sourceforge.net/examples/axes_grid/demo_axisline_style.html`
`60`	`60`	`# http://matplotlib.sourceforge.net/examples/axes_grid/demo_curvelinear_grid.html`
`61`	`61`	`defpzmap(sys,plot=None,grid=None,title='Pole Zero Map',**kwargs):`
`62`		`-"""`
`63`		`- Plot a pole/zero map for a linear system.`
	`62`	`+"""Plot a pole/zero map for a linear system.`
`64`	`63`
`65`	`64`	`Parameters`
`66`	`65`	`----------`
`@@ -78,6 +77,14 @@ def pzmap(sys, plot=None, grid=None, title='Pole Zero Map', **kwargs):`
`78`	`77`	`The systems poles`
`79`	`78`	`zeros: array`
`80`	`79`	`The system's zeros.`
	`80`	`+`
	`81`	`+ Notes`
	`82`	`+ -----`
	`83`	`+ The pzmap function calls matplotlib.pyplot.axis('equal'), which means`
	`84`	`+ that trying to reset the axis limits may not behave as expected. To`
	`85`	`+ change the axis limits, use matplotlib.pyplot.gca().axis('auto') and`
	`86`	`+ then set the axis limits to the desired values.`
	`87`	`+`
`81`	`88`	`"""`
`82`	`89`	`# Check to see if legacy 'Plot' keyword was used`
`83`	`90`	`if'Plot'inkwargs:`

Lines changed: 8 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -114,6 +114,14 @@ def root_locus(sys, kvect=None, xlim=None, ylim=None,`
`114`	`114`	`Computed root locations, given as a 2D array`
`115`	`115`	`klist : ndarray or list`
`116`	`116`	`Gains used. Same as klist keyword argument if provided.`
	`117`	`+`
	`118`	`+ Notes`
	`119`	`+ -----`
	`120`	`+ The root_locus function calls matplotlib.pyplot.axis('equal'), which`
	`121`	`+ means that trying to reset the axis limits may not behave as expected.`
	`122`	`+ To change the axis limits, use matplotlib.pyplot.gca().axis('auto') and`
	`123`	`+ then set the axis limits to the desired values.`
	`124`	`+`
`117`	`125`	`"""`
`118`	`126`	`# Check to see if legacy 'Plot' keyword was used`
`119`	`127`	`if'Plot'inkwargs:`

Comments

(0)