Skip to content

Commit 62436e4

Browse files
committed
Address emilypi's review comments.
- Change copyright/author to 'unordered-containers maintainers' - Change warning about HashMap.!? - Remove incomplete Serialization sections, todo in follow-up.
1 parent 6fedd46 commit 62436e4

File tree

3 files changed

+5
-14
lines changed

3 files changed

+5
-14
lines changed

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929

3030
# General information about the project.
3131
project = u'unordered-containers'
32-
copyright = u'2020, Matt Renaud'
33-
author = u'Matt Renaud'
32+
copyright = u'2020, unordered-containers maintainers'
33+
author = u'unordered-containers maintainers'
3434

3535
# The short X.Y version.
3636
version = u'0.2.10'

docs/hash-map.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -259,8 +259,9 @@ For example::
259259
> "one"
260260

261261
.. WARNING::
262-
**DO NOT** Use ``HashMap.!``. It is partial and throws a runtime error if
263-
the key doesn't exist.
262+
``HashMap.!`` is a partial function and throws a runtime error if
263+
the key doesn't exist. **DO NOT** use it if you are expecting a total
264+
function or cannot tolerate a runtime failure; prefer to use ``lookup``.
264265

265266
Check if a map is empty
266267
"""""""""""""""""""""""
@@ -557,11 +558,6 @@ difference/relative complement
557558
> fromList [(2,"two")]
558559

559560

560-
Serialization
561-
-------------
562-
563-
TODO(m-renaud): Serialization docs.
564-
565561
Performance
566562
-----------
567563

docs/hash-set.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -365,11 +365,6 @@ difference/relative compliment
365365
> fromList [2,4,6]
366366

367367

368-
Serialization
369-
-------------
370-
371-
TODO(m-renaud): Write serialization section.
372-
373368
Performance
374369
-----------
375370

0 commit comments

Comments
 (0)