Skip to content

Commit 1b99ce4

Browse files
committed
Doc adjustments
1 parent c11d296 commit 1b99ce4

File tree

2 files changed

+29
-21
lines changed

2 files changed

+29
-21
lines changed

docs/source/api.rst

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -163,15 +163,17 @@ Properties
163163

164164
:rtype: dict[str, Any]
165165

166-
.. attribute:: pos
166+
.. attribute:: bgra
167167

168-
The screen shot's coordinates.
168+
BGRA values from the BGRA raw pixels.
169169

170-
:rtype: :py:func:`collections.namedtuple()`
170+
:rtype: bytes
171171

172-
.. attribute:: top
172+
.. versionadded:: 3.1.3
173173

174-
The screen shot's top coordinate.
174+
.. attribute:: height
175+
176+
The screen shot's height.
175177

176178
:rtype: int
177179

@@ -181,37 +183,43 @@ Properties
181183

182184
:rtype: int
183185

184-
.. attribute:: size
186+
.. attribute:: pixels
185187

186-
The screen shot's size.
188+
List of RGB tuples.
189+
190+
:rtype: list[tuple(int, int, int)]
191+
192+
.. attribute:: pos
193+
194+
The screen shot's coordinates.
187195

188196
:rtype: :py:func:`collections.namedtuple()`
189197

190-
.. attribute:: width
198+
.. attribute:: rgb
191199

192-
The screen shot's width.
200+
Computed RGB values from the BGRA raw pixels.
193201

194-
:rtype: int
202+
:rtype: bytes
195203

196-
.. attribute:: height
204+
.. versionadded:: 3.0.0
197205

198-
The screen shot's height.
206+
.. attribute:: size
199207

200-
:rtype: int
208+
The screen shot's size.
201209

202-
.. attribute:: pixels
210+
:rtype: :py:func:`collections.namedtuple()`
203211

204-
List of RGB tuples.
212+
.. attribute:: top
205213

206-
:rtype: list[tuple(int, int, int)]
214+
The screen shot's top coordinate.
207215

208-
.. attribute:: rgb
216+
:rtype: int
209217

210-
Computed RGB values from the BGRA raw pixels.
218+
.. attribute:: width
211219

212-
:rtype: bytes
220+
The screen shot's width.
213221

214-
.. versionadded:: 3.0.0
222+
:rtype: int
215223

216224

217225
Exception

mss/screenshot.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ def from_size(cls, data, width, height):
7777
@property
7878
def bgra(self):
7979
# type: () -> bytes
80-
""" Compute BGRA values from the BGRA raw pixels. """
80+
""" BGRA values from the BGRA raw pixels. """
8181
return bytes(self.raw)
8282

8383
@property

0 commit comments

Comments
 (0)