Skip to content

Commit 833af8c

Browse files
committed
[skip ci] Adjust docs
1 parent 7bc7f10 commit 833af8c

4 files changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Current version of Wuffs library used in this project is **0.3.3**.
1616
### Using pip
1717

1818
```bash
19-
python3 -m pip install git+https://github.com/dev0x13/pywuffs.git
19+
python3 -m pip install pywuffs
2020
```
2121

2222
### Using CMake

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pywuffs module
2-
==============
1+
pywuffs: Python bindings for Wuffs the Library
2+
==============================================
33

44
.. automodule:: pywuffs
55
:members:

docs/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
sphinx_epytext
2-
sphinx_rtd_theme
2+
sphinx_rtd_theme
3+
pywuffs

src/wuffs-bindings.cpp

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ PYBIND11_MODULE(pywuffs, m) {
2020
py::class_<wuffs_base__more_information>(
2121
m, "wuffs_base__more_information",
2222
"Holds additional fields. The flavor field follows the base38 namespace "
23-
"convention (https://github.com/google/wuffs/blob/main/doc/note/base38-and-fourcc.md)."
23+
"convention (https://github.com/google/wuffs/blob/main/doc/note/base38-and-fourcc.md). "
2424
"The other fields' semantics depends on the flavor.")
2525
// clang-format on
2626
.def_readonly("flavor", &wuffs_base__more_information::flavor)
@@ -234,12 +234,12 @@ py::enum_<wuffs_aux_wrap::PixelFormat>(
234234
.def_readwrite(
235235
"max_incl_dimension",
236236
&wuffs_aux_wrap::ImageDecoderConfig::max_incl_dimension,
237-
"int: Decoding fails (with DecodeImage_MaxInclDimensionExceeded) if "
237+
"int: Decoding fails (with ImageDecoderErrors.MaxInclDimensionExceeded) if "
238238
"the image's width or height is greater than max_incl_dimension.")
239239
.def_readwrite(
240240
"max_incl_metadata_length",
241241
&wuffs_aux_wrap::ImageDecoderConfig::max_incl_metadata_length,
242-
"int: Decoding fails (with DecodeImage_MaxInclDimensionExceeded) if "
242+
"int: Decoding fails (with ImageDecoderErrors.MaxInclDimensionExceeded) if "
243243
"any opted-in (via flags bits) metadata is longer than "
244244
"max_incl_metadata_length.")
245245
.def_readwrite("enabled_decoders",
@@ -309,12 +309,11 @@ py::enum_<wuffs_aux_wrap::PixelFormat>(
309309
"W, C] shape).")
310310
.def_readonly("pixcfg", &wuffs_aux_wrap::ImageDecodingResult::pixcfg,
311311
"wuffs_base__pixel_config: decoded pixel buffer config.")
312-
.def_readonly(
313-
"reported_metadata",
314-
&wuffs_aux_wrap::ImageDecodingResult::reported_metadata,
315-
"VectorMetadataEntry: a list-like object containing reported data "
316-
"(only filled is any metadata was decoded and the "
317-
"corresponding ImageDecoderFlag flag was set).")
312+
.def_readonly("reported_metadata",
313+
&wuffs_aux_wrap::ImageDecodingResult::reported_metadata,
314+
"list: a list object containing reported data "
315+
"(only filled if any metadata was decoded and the "
316+
"corresponding ImageDecoderFlag flag was set).")
318317
.def_readonly("error_message",
319318
&wuffs_aux_wrap::ImageDecodingResult::error_message,
320319
"str: error message, empty on success, one of "

0 commit comments

Comments
 (0)