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.

Sign up for GitHub

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

Update sensors.rst to add blurb on get_user_info #1172

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update sensors.rst to add blurb on get_user_info #1172

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/source/sensors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,18 @@ For example:
self._logger = self.sensor_service.get_logger(name=self.__class__.__name__)
self._logger.debug('Polling 3rd party system for information')

2. get_user_info(name)
~~~~~~~~~~~~~~~~~~~

This method allows the sensor instance to retrieve the user can retrieve information
about the user account which is used to perform datastore operations.
Comment on lines +134 to +135
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not clear. Could you clean it up?


For example:

.. code-block:: python

username_info = self.sensor_service.get_user_info()

.. _ref-sensors-datastore-management-operations:

Datastore Management Operations
Expand Down