diff options
| author | Miki Watanabe <105326591+MikiPWata@users.noreply.github.com> | 2022-07-21 03:09:31 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-20 21:09:31 +0300 |
| commit | f1e50253a3b56375e795ee72032cca90a3832cd4 (patch) | |
| tree | a6ad8f8b69992889119216def3fc29e92a387f44 /doc/source/reference/maskedarray.baseclass.rst | |
| parent | 606fa1fb6d4ff573675ca146f880c7aa012b42c8 (diff) | |
| download | numpy-f1e50253a3b56375e795ee72032cca90a3832cd4.tar.gz | |
DOC: updated masked_print_option and added explanation (#22013)
Fix misspelling in masked_print_option data entry and add explanation on how to
change the value.
Co-authored-by: 渡邉 美希 <miki.watanabe@watanabenoMacBook-Pro.local>
Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
Diffstat (limited to 'doc/source/reference/maskedarray.baseclass.rst')
| -rw-r--r-- | doc/source/reference/maskedarray.baseclass.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/source/reference/maskedarray.baseclass.rst b/doc/source/reference/maskedarray.baseclass.rst index 44792a0d6..fcd310faa 100644 --- a/doc/source/reference/maskedarray.baseclass.rst +++ b/doc/source/reference/maskedarray.baseclass.rst @@ -35,13 +35,14 @@ defines several constants. is not needed. It is represented internally as ``np.False_``. -.. data:: masked_print_options +.. data:: masked_print_option String used in lieu of missing data when a masked array is printed. By default, this string is ``'--'``. - - + Use ``set_display()`` to change the default string. + Example usage: ``numpy.ma.masked_print_option.set_display('X')`` + replaces missing data with ``'X'``. .. _maskedarray.baseclass: |