Skip to content

docs: fix a few typos #1603

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

Merged
merged 1 commit into from
Sep 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/gl_objects/deploy_tokens.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ the following parameters:

With GitLab 12.9, even though ``username`` and ``expires_at`` are not required, they always have to be passed to the API.
You can set them to empty strings, see: https://gitlab.com/gitlab-org/gitlab/-/issues/211878.
Also, the ``username``'s value is ignored by the API and will be overriden with ``gitlab+deploy-token-{n}``,
Also, the ``username``'s value is ignored by the API and will be overridden with ``gitlab+deploy-token-{n}``,
see: https://gitlab.com/gitlab-org/gitlab/-/issues/211963
These issues were fixed in GitLab 12.10.

Expand Down Expand Up @@ -125,7 +125,7 @@ the following parameters:

With GitLab 12.9, even though ``username`` and ``expires_at`` are not required, they always have to be passed to the API.
You can set them to empty strings, see: https://gitlab.com/gitlab-org/gitlab/-/issues/211878.
Also, the ``username``'s value is ignored by the API and will be overriden with ``gitlab+deploy-token-{n}``,
Also, the ``username``'s value is ignored by the API and will be overridden with ``gitlab+deploy-token-{n}``,
see: https://gitlab.com/gitlab-org/gitlab/-/issues/211963
These issues were fixed in GitLab 12.10.

Expand Down
2 changes: 1 addition & 1 deletion gitlab/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ class RESTObjectList(object):
This generator uses the Gitlab pagination system to fetch new data when
required.

Note: you should not instanciate such objects, they are returned by calls
Note: you should not instantiate such objects, they are returned by calls
to RESTManager.list()

Args:
Expand Down
4 changes: 2 additions & 2 deletions gitlab/mixins.py
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ def set(self, key: str, value: str, **kwargs: Any) -> base.RESTObject:

Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabSetError: If an error occured
GitlabSetError: If an error occurred

Returns:
obj: The created/updated attribute
Expand Down Expand Up @@ -661,7 +661,7 @@ def download(
Args:
streamed (bool): If True the data will be processed by chunks of
`chunk_size` and each chunk is passed to `action` for
reatment
treatment
action (callable): Callable responsible of dealing with chunk of
data
chunk_size (int): Size of each chunk
Expand Down
2 changes: 1 addition & 1 deletion gitlab/v4/objects/features.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def set(

Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabSetError: If an error occured
GitlabSetError: If an error occurred

Returns:
obj: The created/updated attribute
Expand Down
2 changes: 1 addition & 1 deletion gitlab/v4/objects/groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ def transfer_project(self, project_id, **kwargs):

Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabTransferProjectError: If the project could not be transfered
GitlabTransferProjectError: If the project could not be transferred
"""
path = "/groups/%s/projects/%s" % (self.id, project_id)
self.manager.gitlab.http_post(path, **kwargs)
Expand Down
2 changes: 1 addition & 1 deletion gitlab/v4/objects/packages.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ def download(
file_name (str): The name of the file in the registry
streamed (bool): If True the data will be processed by chunks of
`chunk_size` and each chunk is passed to `action` for
reatment
treatment
action (callable): Callable responsible of dealing with chunk of
data
chunk_size (int): Size of each chunk
Expand Down
2 changes: 1 addition & 1 deletion gitlab/v4/objects/projects.py
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@ def transfer_project(self, to_namespace: str, **kwargs: Any) -> None:

Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabTransferProjectError: If the project could not be transfered
GitlabTransferProjectError: If the project could not be transferred
"""
path = "/projects/%s/transfer" % (self.id,)
self.manager.gitlab.http_put(
Expand Down
6 changes: 3 additions & 3 deletions gitlab/v4/objects/sidekiq.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@
class SidekiqManager(RESTManager):
"""Manager for the Sidekiq methods.

This manager doesn't actually manage objects but provides helper fonction
This manager doesn't actually manage objects but provides helper function
for the sidekiq metrics API.
"""

@cli.register_custom_action("SidekiqManager")
@exc.on_http_error(exc.GitlabGetError)
def queue_metrics(self, **kwargs):
"""Return the registred queues information.
"""Return the registered queues information.

Args:
**kwargs: Extra options to send to the server (e.g. sudo)
Expand All @@ -34,7 +34,7 @@ def queue_metrics(self, **kwargs):
@cli.register_custom_action("SidekiqManager")
@exc.on_http_error(exc.GitlabGetError)
def process_metrics(self, **kwargs):
"""Return the registred sidekiq workers.
"""Return the registered sidekiq workers.

Args:
**kwargs: Extra options to send to the server (e.g. sudo)
Expand Down
2 changes: 1 addition & 1 deletion gitlab/v4/objects/todos.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,6 @@ def mark_all_as_done(self, **kwargs):
GitlabTodoError: If the server failed to perform the request

Returns:
int: The number of todos maked done
int: The number of todos marked done
"""
self.gitlab.http_post("/todos/mark_as_done", **kwargs)