[docs] don't use hardcoded values for ids

Gauvain Pocentek · Gauvain Pocentek · commit fe43a2872596 · 2018-06-27T07:40:42.000+02:00
diff --git a/docs/gl_objects/builds.rst b/docs/gl_objects/builds.rst
@@ -92,7 +92,7 @@ Full example with wait for finish::
     pipeline = project.trigger_pipeline('master', trigger.token, variables={"DEPLOY_ZONE": "us-west1"})
     while pipeline.finished_at is None:
         pipeline.refresh()
-        os.sleep(1)
+        time.sleep(1)
 
 Pipeline schedule
 =================
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -56,7 +56,7 @@ Results can also be sorted using the following parameters:
 Get a single project::
 
     # Get a project by ID
-    project = gl.projects.get(10)
+    project = gl.projects.get(project_id)
     # Get a project by userspace/name
     project = gl.projects.get('myteam/myproject')
 
@@ -84,7 +84,7 @@ Update a project::
 
 Delete a project::
 
-    gl.projects.delete(1)
+    gl.projects.delete(project_id)
     # or
     project.delete()
 
@@ -480,7 +480,7 @@ Search project members matching a query string::
 
 Get a single project member::
 
-    member = project.members.get(1)
+    member = project.members.get(user_id)
 
 Add a project member::
 
@@ -526,7 +526,7 @@ List the project hooks::
 
 Get a project hook::
 
-    hook = project.hooks.get(1)
+    hook = project.hooks.get(hook_id)
 
 Create a project hook::
 
@@ -539,7 +539,7 @@ Update a project hook::
 
 Delete a project hook::
 
-    project.hooks.delete(1)
+    project.hooks.delete(hook_id)
     # or
     hook.delete()
 
diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst
@@ -35,7 +35,7 @@ Search users whose username match a given string::
 Get a single user::
 
     # by ID
-    user = gl.users.get(2)
+    user = gl.users.get(user_id)
     # by username
     user = gl.users.list(username='root')[0]
 
@@ -53,7 +53,8 @@ Update a user::
 
 Delete a user::
 
-    gl.users.delete(2)
+    gl.users.delete(user_id)
+    # or
     user.delete()
 
 Block/Unblock a user::
@@ -198,7 +199,7 @@ List GPG keys for a user::
 
 Get a GPG gpgkey for a user::
 
-    gpgkey = user.gpgkeys.get(1)
+    gpgkey = user.gpgkeys.get(key_id)
 
 Create a GPG gpgkey for a user::
 
@@ -207,7 +208,7 @@ Create a GPG gpgkey for a user::
 
 Delete a GPG gpgkey for a user::
 
-    user.gpgkeys.delete(1)
+    user.gpgkeys.delete(key_id)
     # or
     gpgkey.delete()
 
@@ -245,7 +246,7 @@ Create an SSH key for a user::
 
 Delete an SSH key for a user::
 
-    user.keys.delete(1)
+    user.keys.delete(key_id)
     # or
     key.delete()
 
@@ -278,17 +279,15 @@ List emails for a user::
 
 Get an email for a user::
 
-    email = gl.user_emails.list(1, user_id=1)
-    # or
-    email = user.emails.get(1)
+    email = user.emails.get(email_id)
 
 Create an email for a user::
 
     k = user.emails.create({'email': 'foo@bar.com'})
 
 Delete an email for a user::
 
-    user.emails.delete(1)
+    user.emails.delete(email_id)
     # or
     email.delete()
 
