Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit a2d2c37

Browse filesBrowse files
committed
Add a description for the 'metadata' keyword to the docstring
1 parent 98b5587 commit a2d2c37
Copy full SHA for a2d2c37

File tree

Expand file treeCollapse file tree

1 file changed

+18
-0
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+18
-0
lines changed

‎src/_png.cpp

Copy file name to clipboardExpand all lines: src/_png.cpp
+18Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,24 @@ const char *Py_write_png__doc__ =
114114
" If not provided, libpng will try to automatically determine the\n"
115115
" best filter on a line-by-line basis.\n"
116116
"\n"
117+
"metadata : dictionary\n"
118+
" The keyword-text pairs that are stored as comments in the image.\n"
119+
" Keys must be shorter than 79 chars. The only supported encoding\n"
120+
" for both keywords and values is Latin-1 (ISO 8859-1).\n"
121+
" Examples given in the PNG Specification are:\n"
122+
" - Title: Short (one line) title or caption for image\n"
123+
" - Author: Name of image's creator\n"
124+
" - Description: Description of image (possibly long)\n"
125+
" - Copyright: Copyright notice\n"
126+
" - Creation Time: Time of original image creation\n"
127+
" (usually RFC 1123 format, see below)\n"
128+
" - Software: Software used to create the image\n"
129+
" - Disclaimer: Legal disclaimer\n"
130+
" - Warning: Warning of nature of content\n"
131+
" - Source: Device used to create the image\n"
132+
" - Comment: Miscellaneous comment; conversion\n"
133+
" from other image format\n"
134+
"\n"
117135
"Returns\n"
118136
"-------\n"
119137
"buffer : bytes or None\n"

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.