diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2019-11-09 17:19:42 -0500 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2019-11-09 19:42:42 -0500 |
| commit | fc249034d7b8d7ac20b7f5fddde6f922442b2dfa (patch) | |
| tree | c6e07c1cfb23e4126fce205fbee1fe856f85d2b5 /doc | |
| parent | da73d5a36f9eaff8e7d5e8d2d1d2c93a33ba6403 (diff) | |
| download | python-coveragepy-git-fc249034d7b8d7ac20b7f5fddde6f922442b2dfa.tar.gz | |
'[run] note' is no longer supported.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 4 | ||||
| -rw-r--r-- | doc/whatsnew5x.rst | 4 |
2 files changed, 5 insertions, 3 deletions
diff --git a/doc/config.rst b/doc/config.rst index f7483d06..ed0024cb 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -170,9 +170,7 @@ for details. .. _config_run_note: -``note`` (string): an arbitrary string that will be written to the data file. -You can use the :meth:`.CoverageData.run_infos` method to retrieve this string -from a data file. +``note`` (string): this is now obsolete. .. _config_run_omit: diff --git a/doc/whatsnew5x.rst b/doc/whatsnew5x.rst index 479895e2..c709d384 100644 --- a/doc/whatsnew5x.rst +++ b/doc/whatsnew5x.rst @@ -33,6 +33,10 @@ Backward Incompatibilities circumstances, you may need to use ``parallel=true`` to avoid multiple processes overwriting each others' data. +- The ``[run] note`` setting has been deprecated. Using it will result in a + warning, and the note will not be written to the data file. The + corresponding :class:`.CoverageData` methods have been removed. + - The deprecated `Reporter.file_reporters` property has been removed. - The reporting methods used to permanently apply their arguments to the |