Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clear documentation for Processors #689

Merged
merged 10 commits into from
Jul 13, 2022
8 changes: 5 additions & 3 deletions plyer/facades/processors.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
'''
Number of Processors
=======
The :class:`Processors` provides a information on the number of
processors in a system
rshah713 marked this conversation as resolved.
Show resolved Hide resolved
.. note::
Deprecated in favor of `cpu`

Simple Example
---------------
To get battery status::
To get processors status::
>>> from plyer import processors
>>> processors.status
{'Number_of_Processors': '4'}
Expand Down Expand Up @@ -34,7 +38,5 @@ def status(self):
def get_state(self):
return self._get_state()

# private

def _get_state(self):
raise NotImplementedError()