xonsh/docs/api
David Dotson a8d4a57f01
Environment variable registration, deregistration (addresses #3227) (#3377)
* First attempt at register/deregister machinery for envvars

* Added detailed docstring, simplified ensurers

Also added some type checking that became clear from docstring writing.

* Changes in response to @scopatz review

Simplified kwarg names.

* defaultval -> default

* Created new Var namedtuple, as well as DEFAULT_VARS

We should now delete DEFAULT_ENSURERS, DEFAULT_VALUES, DEFAULT_DOCS, and
refactor Env to use the new single namedtuple and the DEFAULT_VARS dict

* Removed DEFAULT_ENSURERS, DEFAULT_VALUES, DEFAULT_DOCS

Now need to edit Env to use new DEFAULT_VARS, Var namedtuple

* Finished updating Env object to use new combined Var

Also made corresponding changes elsewhere ensurer was used

* Working on test failures

* More fixes in light of test failures

* Set default values for Var in register.

There's a bit of duplication here, but makes for a cleaner function.

* Black reformatting on environ.py

* Removed history replay

* Added register tests

* Added addtional deregistration test

* Removed all replay references, in docs too

* Added news item for env-reg-dereg

* trigger rebuild

* doc fix

* more doc fixes

* again

* attr names

* reorder imports

* fix flake error

Co-authored-by: Anthony Scopatz <scopatz@gmail.com>
2020-08-05 10:39:11 -04:00
..
completers some doc fixes 2018-07-19 19:59:07 -04:00
history Greatly improved webpage layout so it is easier to find what you need. (#2477) 2017-08-13 21:48:26 -04:00
lib add docs 2019-09-09 21:04:32 -04:00
prompt more doc fixes 2016-12-20 13:47:58 -08:00
ptk_shell Add ptk3 (#3521) 2020-04-18 10:44:27 -04:00
xoreutils audodoc hooks 2017-02-12 18:36:50 -05:00
aliases.rst more autodoc hooks 2015-03-07 20:24:07 -06:00
ast.rst language api docs 2015-03-07 20:11:33 -06:00
base_shell.rst some doc fixes. 2015-10-12 00:45:03 -04:00
blank.rst add completer API doc hooks 2016-06-04 20:05:55 -04:00
built_ins.rst more autodoc hooks 2015-03-07 20:24:07 -06:00
codecache.rst documentation 2016-05-12 11:53:15 -04:00
color_tools.rst added news and docs 2017-02-21 00:15:34 -05:00
commands_cache.rst minor doc fixes 2016-06-24 14:20:37 -04:00
completer.rst typo 2015-03-09 01:03:47 -05:00
contexts.rst even more docs 2016-06-05 22:41:56 -04:00
diff_history.rst started history differ 2015-08-23 22:57:36 -04:00
dirstack.rst documentation for dirstack module 2015-03-21 20:01:10 -04:00
dumb_shell.rst dumb terminal support 2018-12-13 16:02:59 -05:00
environ.rst more autodoc hooks 2015-03-07 20:24:07 -06:00
events.rst Typo 2016-08-27 23:16:11 -04:00
execer.rst Fix typo in Execer page title 2018-01-13 14:24:46 -05:00
foreign_shells.rst added tests for foreign shells 2015-10-10 19:52:53 -04:00
imphooks.rst import hooks docs 2015-03-30 00:11:37 -05:00
index.rst Environment variable registration, deregistration (addresses #3227) (#3377) 2020-08-05 10:39:11 -04:00
inspectors.rst done with docs/api 2015-03-07 20:30:45 -06:00
jobs.rst job control: documentation 2015-03-27 02:07:17 -04:00
jsonutils.rst rename jsonutils so sphinx sees it 2017-02-28 15:13:30 -05:00
jupyter_kernel.rst docs for jupyter kernel 2015-10-04 15:00:00 -04:00
jupyter_shell.rst have jupyter streaming output 2018-08-02 18:08:44 -04:00
lazyasd.rst more docs 2016-06-25 12:50:57 -04:00
lazyjson.rst more docs 2015-05-03 20:09:26 -05:00
lexer.rst some doc fixes 2015-03-23 01:15:48 -05:00
main.rst some doc updates 2015-03-07 19:30:06 -06:00
mplhooks.rst interim add 2016-05-11 00:42:36 -04:00
openpy.rst more autodoc hooks 2015-03-07 20:24:07 -06:00
parser.rst language api docs 2015-03-07 20:11:33 -06:00
platform.rst some doc fixes 2016-06-18 17:32:37 -04:00
pretty.rst Added the pretty module to the documentation 2015-07-16 12:58:00 +02:00
proc.rst some minor doc fixes 2016-07-20 21:27:17 -04:00
pyghooks.rst recursive impl 2015-03-31 01:10:19 -05:00
readline_shell.rst Add prompt_toolkit based shell. 2015-05-16 19:34:44 +02:00
shell.rst Add prompt_toolkit based shell. 2015-05-16 19:34:44 +02:00
tools.rst some doc updates 2015-03-07 19:30:06 -06:00
tracer.rst added tracer mod 2016-02-05 01:45:05 -05:00
vox.rst Refactor machinery into voxapi in order to minimize global namespace pollution. 2016-07-20 16:22:23 -04:00
wizard.rst autogen config var docs 2016-01-06 01:55:40 -08:00
xonfig.rst autogen config var docs 2016-01-06 01:55:40 -08:00