matplotlib.github.com/3.4.0/_modules/matplotlib/docstring.html at main · ACPMAD/matplotlib.github.com

History

211 lines (170 loc) · 13.1 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>matplotlib.docstring — Matplotlib 3.4.0 documentation</title>

title="Search within Matplotlib 3.4.0 documentation"

href="../../_static/opensearch.xml"/>

</head><body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.4.0). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>

<!--

</div>

-->

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.4.0</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<ul>

<li><a href="../../users/installing.html">Installation</a></li>

<li><a href="../../contents.html">Documentation</a></li>

<li><a href="../../gallery/index.html">Examples</a></li>

<li><a href="../../tutorials/index.html">Tutorials</a></li>

<li><a href="../../devel/index.html">Contributing</a></li>

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li><a href="../../contents.html">contents</a> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>

<li class="nav-item nav-item-2"><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>

<li class="nav-item nav-item-this"><a href="">matplotlib.docstring</a></li>

</ul>

</div>

</div>

<h1>Source code for matplotlib.docstring</h1><div class="highlight"><pre>

import inspect

from matplotlib import _api

<div class="viewcode-block" id="Substitution"><a class="viewcode-back" href="../../api/docstring_api.html#matplotlib.docstring.Substitution">[docs]</a>class Substitution:

"""

A decorator that performs %-substitution on an object's docstring.

This decorator should be robust even if ``obj.__doc__`` is None (for

example, if -OO was passed to the interpreter).

Usage: construct a docstring.Substitution with a sequence or dictionary

suitable for performing substitution; then decorate a suitable function

with the constructed object, e.g.::

sub_author_name = Substitution(author='Jason')

@sub_author_name

def some_function(x):

"%(author)s wrote this function"

# note that some_function.__doc__ is now "Jason wrote this function"

One can also use positional arguments::

sub_first_last_names = Substitution('Edgar Allen', 'Poe')

@sub_first_last_names

def some_function(x):

"%s %s wrote the Raven"

"""

def __init__(self, *args, **kwargs):

if args and kwargs:

raise TypeError("Only positional or keyword args are allowed")

self.params = args or kwargs

def __call__(self, func):

if func.__doc__:

func.__doc__ = inspect.cleandoc(func.__doc__) % self.params

return func

<div class="viewcode-block" id="Substitution.update"><a class="viewcode-back" href="../../api/docstring_api.html#matplotlib.docstring.Substitution.update">[docs]</a> def update(self, *args, **kwargs):

"""

Update ``self.params`` (which must be a dict) with the supplied args.

"""

self.params.update(*args, **kwargs)</div>

@classmethod

@_api.deprecated("3.3", alternative="assign to the params attribute")

def from_params(cls, params):

"""

In the case where the params is a mutable sequence (list or

dictionary) and it may change before this class is called, one may

explicitly use a reference to the params rather than using *args or

**kwargs which will copy the values and not reference them.

:meta private:

"""

result = cls()

result.params = params

return result</div>

<div class="viewcode-block" id="copy"><a class="viewcode-back" href="../../api/docstring_api.html#matplotlib.docstring.copy">[docs]</a>def copy(source):

"""Copy a docstring from another source function (if present)."""

def do_copy(target):

if source.__doc__:

target.__doc__ = source.__doc__

return target

return do_copy</div>

# Create a decorator that will house the various docstring snippets reused

# throughout Matplotlib.

interpd = Substitution()

dedent_interpd = interpd

</pre></div>

</div>

</div>

Last updated on Mar 26, 2021.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 3.2.1.

Doc version v3.4.0-2-gcb03754703.

</div>

</footer>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-55954603-1', 'auto');

ga('send', 'pageview');

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

docstring.html

Latest commit

History

docstring.html

File metadata and controls