Fri, 22 Jan 2021 16:48:43 +0100
Editor
- added functionality to insert docstring templates via the context menu (cursor placed on first line of function definition) or after entering the docstring start string (e.g. """ for Python)
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | <!DOCTYPE html> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <html><head> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | <title>eric6.eric6config</title> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | <meta charset="UTF-8"> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
5 | <style> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | body { |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | background: #EDECE6; |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | margin: 0em 1em 10em 1em; |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | color: black; |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | h1 { color: white; background: #85774A; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
13 | h2 { color: white; background: #85774A; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | h3 { color: white; background: #9D936E; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | h4 { color: white; background: #9D936E; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | a { color: #BA6D36; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
18 | |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | </style> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | </head> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
21 | <body> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
22 | <a NAME="top" ID="top"></a> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | <h1>eric6.eric6config</h1> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
24 | |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | <p> |
7960
e8fc383322f7
Harmonized some user visible strings and changed the term 'eric6' to the more generic 'eric'.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7273
diff
changeset
|
26 | Module containing the default configuration of the eric installation. |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | </p> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | <h3>Global Attributes</h3> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
29 | |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | <table> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | <tr><td>__ericDir</td></tr><tr><td>_pkg_config</td></tr> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | </table> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | <h3>Classes</h3> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
34 | |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
35 | <table> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | <tr><td>None</td></tr> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | </table> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | <h3>Functions</h3> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
39 | |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | <table> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
41 | |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | <tr> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | <td><a href="#getConfig">getConfig</a></td> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
44 | <td>Module function to get a configuration value.</td> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
45 | </tr> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
46 | </table> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
47 | <hr /> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
48 | <hr /> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
49 | <a NAME="getConfig" ID="getConfig"></a> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
50 | <h2>getConfig</h2> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
51 | <b>getConfig</b>(<i>name</i>) |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
52 | |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
53 | <p> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
54 | Module function to get a configuration value. |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
55 | </p> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
56 | <dl> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
57 | |
5643
651caaf478cb
Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
58 | <dt><i>name</i> (str)</dt> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
59 | <dd> |
5643
651caaf478cb
Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
60 | name of the configuration value |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
61 | </dd> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
62 | </dl> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
63 | <dl> |
7989
a21d673a8f99
Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7960
diff
changeset
|
64 | <dt>Return:</dt> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | <dd> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | requested config value |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67 | </dd> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
68 | </dl> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
69 | <dl> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
70 | |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
71 | <dt>Raises <b>AttributeError</b>:</dt> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
72 | <dd> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
73 | raised to indicate an invalid config entry |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
74 | </dd> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
75 | </dl> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
76 | <div align="right"><a href="#top">Up</a></div> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
77 | <hr /> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
78 | </body></html> |