NotificationsYou must be signed in to change notification settings
Fork673
Star2.4k

Commitfe43a28

Gauvain Pocentek

committed

[docs] don't use hardcoded values for ids

1 parent5e6330f commitfe43a28Copy full SHA for fe43a28

File tree

3 files changed

+14

-15

lines changed

docs/gl_objects

3 files changed

+14

-15

lines changed

`‎docs/gl_objects/builds.rst`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ Full example with wait for finish::`
`92`	`92`	`pipeline = project.trigger_pipeline('master', trigger.token, variables={"DEPLOY_ZONE": "us-west1"})`
`93`	`93`	`while pipeline.finished_at is None:`
`94`	`94`	`pipeline.refresh()`
`95`		`-os.sleep(1)`
	`95`	`+time.sleep(1)`
`96`	`96`
`97`	`97`	`Pipeline schedule`
`98`	`98`	`=================`

`‎docs/gl_objects/projects.rst`

Lines changed: 5 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ Results can also be sorted using the following parameters:`
`56`	`56`	`Get a single project::`
`57`	`57`
`58`	`58`	`# Get a project by ID`
`59`		`- project = gl.projects.get(10)`
	`59`	`+ project = gl.projects.get(project_id)`
`60`	`60`	`# Get a project by userspace/name`
`61`	`61`	`project = gl.projects.get('myteam/myproject')`
`62`	`62`
`@@ -84,7 +84,7 @@ Update a project::`
`84`	`84`
`85`	`85`	`Delete a project::`
`86`	`86`
`87`		`- gl.projects.delete(1)`
	`87`	`+ gl.projects.delete(project_id)`
`88`	`88`	`# or`
`89`	`89`	`project.delete()`
`90`	`90`
`@@ -480,7 +480,7 @@ Search project members matching a query string::`
`480`	`480`
`481`	`481`	`Get a single project member::`
`482`	`482`
`483`		`- member = project.members.get(1)`
	`483`	`+ member = project.members.get(user_id)`
`484`	`484`
`485`	`485`	`Add a project member::`
`486`	`486`
`@@ -526,7 +526,7 @@ List the project hooks::`
`526`	`526`
`527`	`527`	`Get a project hook::`
`528`	`528`
`529`		`- hook = project.hooks.get(1)`
	`529`	`+ hook = project.hooks.get(hook_id)`
`530`	`530`
`531`	`531`	`Create a project hook::`
`532`	`532`
`@@ -539,7 +539,7 @@ Update a project hook::`
`539`	`539`
`540`	`540`	`Delete a project hook::`
`541`	`541`
`542`		`- project.hooks.delete(1)`
	`542`	`+ project.hooks.delete(hook_id)`
`543`	`543`	`# or`
`544`	`544`	`hook.delete()`
`545`	`545`

`‎docs/gl_objects/users.rst`

Lines changed: 8 additions & 9 deletions

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ Search users whose username match a given string::`
`35`	`35`	`Get a single user::`
`36`	`36`
`37`	`37`	`# by ID`
`38`		`- user = gl.users.get(2)`
	`38`	`+ user = gl.users.get(user_id)`
`39`	`39`	`# by username`
`40`	`40`	`user = gl.users.list(username='root')[0]`
`41`	`41`
`@@ -53,7 +53,8 @@ Update a user::`
`53`	`53`
`54`	`54`	`Delete a user::`
`55`	`55`
`56`		`- gl.users.delete(2)`
	`56`	`+ gl.users.delete(user_id)`
	`57`	`+ # or`
`57`	`58`	`user.delete()`
`58`	`59`
`59`	`60`	`Block/Unblock a user::`
`@@ -198,7 +199,7 @@ List GPG keys for a user::`
`198`	`199`
`199`	`200`	`Get a GPG gpgkey for a user::`
`200`	`201`
`201`		`- gpgkey = user.gpgkeys.get(1)`
	`202`	`+ gpgkey = user.gpgkeys.get(key_id)`
`202`	`203`
`203`	`204`	`Create a GPG gpgkey for a user::`
`204`	`205`
`@@ -207,7 +208,7 @@ Create a GPG gpgkey for a user::`
`207`	`208`
`208`	`209`	`Delete a GPG gpgkey for a user::`
`209`	`210`
`210`		`- user.gpgkeys.delete(1)`
	`211`	`+ user.gpgkeys.delete(key_id)`
`211`	`212`	`# or`
`212`	`213`	`gpgkey.delete()`
`213`	`214`
`@@ -245,7 +246,7 @@ Create an SSH key for a user::`
`245`	`246`
`246`	`247`	`Delete an SSH key for a user::`
`247`	`248`
`248`		`- user.keys.delete(1)`
	`249`	`+ user.keys.delete(key_id)`
`249`	`250`	`# or`
`250`	`251`	`key.delete()`
`251`	`252`
`@@ -278,17 +279,15 @@ List emails for a user::`
`278`	`279`
`279`	`280`	`Get an email for a user::`
`280`	`281`
`281`		`- email = gl.user_emails.list(1, user_id=1)`
`282`		`- # or`
`283`		`- email = user.emails.get(1)`
	`282`	`+ email = user.emails.get(email_id)`
`284`	`283`
`285`	`284`	`Create an email for a user::`
`286`	`285`
`287`	`286`	`k = user.emails.create({'email': 'foo@bar.com'})`
`288`	`287`
`289`	`288`	`Delete an email for a user::`
`290`	`289`
`291`		`- user.emails.delete(1)`
	`290`	`+ user.emails.delete(email_id)`
`292`	`291`	`# or`
`293`	`292`	`email.delete()`
`294`	`293`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commitfe43a28

File tree

3 files changed

3 files changed

`‎docs/gl_objects/builds.rst`

`‎docs/gl_objects/projects.rst`

`‎docs/gl_objects/users.rst`

0 commit comments