Skip to content

Commit

Permalink
bump docs version for 20.0.0 and write changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
mahmoud committed Jan 8, 2020
1 parent 79b7829 commit c847dea
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 19 deletions.
38 changes: 23 additions & 15 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,32 @@
boltons Changelog
=================

Since February 20, 2013 there have been 40 releases and 1386 commits for
an average of one 35-commit release about every 10 weeks.
Since February 20, 2013 there have been 41 releases and 1405 commits for
an average of one 34-commit release about every 8 weeks.


19.4.0
20.0.0
------
*(Unreleased)*

New module [pathutils][pathutils]:

* [pathutils.augpath][pathutils.augpath] augments a path by modifying its components
* [pathutils.shrinkuser][pathutils.shrinkuser] inverts :func:`os.path.expanduser`.
* [pathutils.expandpath][pathutils.expandpath] shell-like environ and tilde expansion

[pathutils.augpath]: https://boltons.readthedocs.io/en/latest/funcutils.html#boltons.pathutils.augpath
[pathutils.shrinkuser]: https://boltons.readthedocs.io/en/latest/funcutils.html#boltons.pathutils.shrinkuser
[pathutils.expandpath]: https://boltons.readthedocs.io/en/latest/funcutils.html#boltons.pathutils.expandpath

*January 8, 2020*

* New module [pathutils][pathutils]:
* [pathutils.augpath][pathutils.augpath] augments a path by modifying its components
* [pathutils.shrinkuser][pathutils.shrinkuser] inverts :func:`os.path.expanduser`.
* [pathutils.expandpath][pathutils.expandpath] shell-like environ and tilde expansion
* add `include_dirs` param to [fileutils.iter_find_files][fileutils.iter_find_files]
* Make [funcutils.format_invocation][funcutils.format_invocation] more deterministic
* add [strutils.unwrap_text][strutils.unwrap_text] which does what you think to wrapped text
* Py3 fixes
* [strutils.chunked][strutils.chunked] to work with the `bytes` type ([#231][i231])
* [cacheutils.ThresholdCounter][cacheutils.ThresholdCounter]'s `get_common_count()`

[i231]: https://github.com/mahmoud/boltons/issues/231
[pathutils]: https://boltons.readthedocs.io/en/latest/pathutils.html
[pathutils.augpath]: https://boltons.readthedocs.io/en/latest/pathutils.html#boltons.pathutils.augpath
[pathutils.augpath]: https://boltons.readthedocs.io/en/latest/pathutils.html#boltons.pathutils.augpath
[pathutils.shrinkuser]: https://boltons.readthedocs.io/en/latest/pathutils.html#boltons.pathutils.shrinkuser
[pathutils.expandpath]: https://boltons.readthedocs.io/en/latest/pathutils.html#boltons.pathutils.expandpath
[strutils.unwrap_text]: https://boltons.readthedocs.io/en/latest/strutils.html#boltons.strutils.unwrap_text

19.3.0
------
Expand Down
2 changes: 1 addition & 1 deletion boltons/strutils.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
'asciify', 'is_ascii', 'is_uuid', 'html2text', 'strip_ansi',
'bytes2human', 'find_hashtags', 'a10n', 'gzip_bytes', 'gunzip_bytes',
'iter_splitlines', 'indent', 'escape_shell_args',
'args2cmd', 'args2sh', 'parse_int_list', 'format_int_list']
'args2cmd', 'args2sh', 'parse_int_list', 'format_int_list', 'unwrap_text']


_punct_ws_str = string.punctuation + string.whitespace
Expand Down
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,11 @@ def get_mod_stats():

# General information about the project.
project = u'boltons'
copyright = u'2019, Mahmoud Hashemi'
copyright = u'2020, Mahmoud Hashemi'
author = u'Mahmoud Hashemi'

version = '19.3'
release = '19.3.0'
version = '20.0'
release = '20.0.0'

if os.name != 'nt':
today_fmt = '%B %d, %Y'
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ Section listing
mathutils
mboxutils
namedutils
pathutils
queueutils
setutils
socketutils
Expand Down
6 changes: 6 additions & 0 deletions docs/pathutils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
``pathutils`` - Filesystem fun
==============================

.. automodule:: boltons.pathutils
:members:
:undoc-members:

0 comments on commit c847dea

Please sign in to comment.