Improve (inline) documentation

Author: amotl

.github/workflows/test.yml

@@ -25,6 +25,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
+          # Only needed for `pypy3`.
           sudo apt install libxml2-dev libxslt-dev
           python -m pip install --upgrade pip
           python -m pip install .[test]

README.md

@@ -39,7 +39,7 @@ Connect to your Grafana API endpoint using the `GrafanaApi` class.
 ```python
 from grafana_client import GrafanaApi
 
-grafana = GrafanaApi(auth='abcde....', host='grafana.example.org')
+grafana = GrafanaApi(auth='eyJrIjoiWHg...dGJpZCI6MX0=', host='grafana.example.org')
 
 # Create user
 user = grafana.admin.create_user(
@@ -52,7 +52,7 @@ user = grafana.admin.change_user_password(2, "newpassword")
 grafana.search.search_dashboards(tag='applications')
 
 # Find a user by email
-user = grafana.users.find_user('test@test.com')
+user = grafana.users.find_user('test@example.org')
 
 # Add user to team 2
 grafana.teams.add_team_member(2, user["id"])

test/elements/test_team.py

@@ -144,14 +144,14 @@ def test_get_team(self, m):
     @requests_mock.Mocker()
     def test_add_team(self, m):
         m.post("http://localhost/api/teams", json={"message": "Team created", "teamId": 2})
-        team = {"name": "MySecondTestTeam", "email": "email@test.com"}
+        team = {"name": "MySecondTestTeam", "email": "email@example.org"}
         new_team = self.grafana.teams.add_team(team)
         self.assertEqual(new_team["teamId"], 2)
 
     @requests_mock.Mocker()
     def test_update_team(self, m):
         m.put("http://localhost/api/teams/3", json={"message": "Team updated"})
-        team = {"name": "MyThirdTestTeam", "email": "email@test.com"}
+        team = {"name": "MyThirdTestTeam", "email": "email@example.org"}
         response = self.grafana.teams.update_team(3, team)
         self.assertEqual(response["message"], "Team updated")
 

test/test_grafana_client.py

@@ -34,7 +34,7 @@ def test_grafana_client(self, mock_get):
   "isGrafanaAdmin": true
 }"""
         grafana = GrafanaApi(("admin", "admin"), host="localhost", url_path_prefix="", protocol="https")
-        grafana.users.find_user("test@test.com")
+        grafana.users.find_user("test@example.org")
 
     def test_grafana_client_no_verify(self):
         grafana = GrafanaApi(
@@ -58,9 +58,9 @@ def test_grafana_client_no_verify(self):
         )
 
         basic_auth = requests.auth.HTTPBasicAuth("admin", "admin")
-        grafana.users.find_user("test@test.com")
+        grafana.users.find_user("test@example.org")
         grafana.client.s.get.assert_called_once_with(
-            "https://localhost/api/users/lookup?loginOrEmail=test@test.com",
+            "https://localhost/api/users/lookup?loginOrEmail=test@example.org",
             auth=basic_auth,
             headers=None,
             json=None,