summaryrefslogtreecommitdiff
path: root/docs/utils.rst
Commit message (Collapse)AuthorAgeFilesLines
* remove Python 2/3 from docsdrop-python2David Lord2020-04-201-22/+12
|
* f-strings everywhereDavid Lord2020-04-191-6/+5
|
* clarify multiple optionsChris Sullins2020-02-231-2/+2
|
* Restore progressbar iterator interface; add testStephen Rosen2020-02-161-0/+10
| | | | | | | | | | | | | | | | | | | | - add a test for iterating on a progressbar with next() - implement `next()` in terms of `iter(ProgressBar)`, which is already well-defined - add a note about slow operations with progressbar to narrative docs One of the keys to this working is that `ProgressBar.generator` is consuming an iterable and doesn't store any important state in local variables, making it re-entry safe. I wasn't sure how we can best hint in the public docs that simply walking the bar and stopping one step short of finishing will result in the progress bar "hanging" unfinished. Noting that we work well with things like `time.sleep()` seems like a decent way of advertising positively something which we support *and* guiding anyone going off-book into proper usage. closes #1125
* new docs linksDavid Lord2018-09-251-2/+2
|
* Fixes documentation issue #334Robert Graham2018-05-151-1/+2
| | | | | Docs updated to reflect that ANSI color info isn't parsed from bytearrays in Python 2.
* Merge pull request #883 from jacobtolar/doc-cleanupZachery Bir2018-05-151-2/+2
|\ | | | | Clean up Sphinx errors.
| * Clean up Sphinx errors.Jacob Tolar2017-10-281-2/+2
| |
* | Merge pull request #889 from stefreak/masterDan Sully2018-05-141-0/+11
|\ \ | | | | | | Implement streaming pager. Fixes #409
| * | Implement streaming pager. Fixes #409Steffen Neubauer2018-04-041-0/+11
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The streaming pager works using generators. You can pass a generator function or object into echo_via_pager: generator expression: ``` click.echo_via_pager(("{}\n".format(i) for i in range(999999))) ``` generator function / expression: ``` def gen(): counter = 0 while True: counter++ yield counter click.echo_via_pager(gen) click.echo_via_pager(gen()) # you can pass both ```
* | Change pypi.python.org urls to pypi.orgAhmed Et-tanany2018-05-101-1/+1
|/ | | | | | More details about this change can be found at: https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
* Fix typos in docs (#623)Radovan Bast2017-01-291-1/+1
|
* fix minor doc typo: "pf" -> "of"Tal Einat2015-12-031-1/+1
|
* Documented wincmdArmin Ronacher2015-11-061-0/+19
|
* Fix some typosMarkus Unterwaditzer2015-03-311-1/+1
|
* Added support for manually advancing progressbars.Armin Ronacher2015-03-311-0/+11
|
* Added err to click echo docsArmin Ronacher2014-08-121-0/+7
|
* Added open_file function.Armin Ronacher2014-08-121-0/+25
|
* Capitalized instances of Click (addressing #128)Kevin Yap2014-06-141-6/+6
|
* Documentation improvementsKevin Yap2014-06-011-10/+10
|
* Added bold argument to ANSI colour examplesKevin Yap2014-06-011-3/+3
| | | | | Implicitly reinforces the idea that styling as well as colouring can be done with the click.style() function.
* Minor documentation fixesKevin Yap2014-06-011-4/+4
|
* Changed occurrences of "on Python" to "in Python"Kevin Yap2014-05-311-6/+6
|
* Documentation fixesKevin Yap2014-06-011-41/+41
|
* Docs: minor fixesJulen Ruiz Aizpuru2014-05-311-1/+1
|
* Added click.pauseArmin Ronacher2014-05-311-0/+21
|
* More documentation fixesKevin Yap2014-05-301-23/+23
|
* Merge pull request #104 from julen/doc-fixesArmin Ronacher2014-05-301-1/+1
|\ | | | | Docs: several fixes
| * Docs: several fixesJulen Ruiz Aizpuru2014-05-291-1/+1
| |
* | open -> launchArmin Ronacher2014-05-301-2/+2
|/
* Moved pager support in the docsArmin Ronacher2014-05-301-0/+17
|
* Added notes on keyboard interruptsArmin Ronacher2014-05-301-0/+7
|
* Added getchar()Armin Ronacher2014-05-301-0/+32
|
* Added click.launchArmin Ronacher2014-05-281-0/+17
|
* Added an edit function.Armin Ronacher2014-05-281-0/+30
|
* Added sechoArmin Ronacher2014-05-271-0/+7
|
* Added style helpers and added deeper ansi color support. Colorama now optional.Armin Ronacher2014-05-271-11/+10
|
* print -> click.echoArmin Ronacher2014-05-261-1/+1
|
* Added colorama exampleArmin Ronacher2014-05-261-0/+7
|
* Added support for screen clearing.Armin Ronacher2014-05-261-0/+15
|
* Docs: minor fixesJulen Ruiz Aizpuru2014-05-261-2/+2
|
* Docs: progressbar fixesJulen Ruiz Aizpuru2014-05-261-1/+1
|
* Cross link for ansi colors.Armin Ronacher2014-05-261-0/+2
|
* Added note on colorama installation.Armin Ronacher2014-05-261-0/+9
|
* Added colorama support into the echo function.Armin Ronacher2014-05-261-0/+23
|
* Documented new functions in utilsArmin Ronacher2014-05-261-0/+76
|
* Docs: fixesJulen Ruiz Aizpuru2014-05-221-4/+4
|
* Added filename format functionArmin Ronacher2014-05-221-0/+18
|
* Merge pull request #80 from dirn/patch-1Armin Ronacher2014-05-131-2/+2
|\ | | | | Fix typo in docs
| * Fix typo in docsAndy Dirnberger2014-05-121-2/+2
| | | | | | This typo is in a section heading. It will change the anchor name for the section.