diff options
| author | Jakub Wilk <jwilk@jwilk.net> | 2018-03-03 00:17:08 +0100 |
|---|---|---|
| committer | Jakub Wilk <jwilk@jwilk.net> | 2018-03-03 00:17:08 +0100 |
| commit | c976fec6c1bbf8c37cc23b9c2d07efbdd39a1670 (patch) | |
| tree | c86a667c377ebd61d64bef98332b4b408b30efa2 /docs | |
| parent | e65dfa30f9699292ffb911511ecd7c347a03775c (diff) | |
| download | gitlab-c976fec6c1bbf8c37cc23b9c2d07efbdd39a1670.tar.gz | |
Fix typos in documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-usage.rst | 4 | ||||
| -rw-r--r-- | docs/gl_objects/events.rst | 2 | ||||
| -rw-r--r-- | docs/gl_objects/projects.rst | 2 | ||||
| -rw-r--r-- | docs/gl_objects/users.rst | 6 |
4 files changed, 7 insertions, 7 deletions
diff --git a/docs/api-usage.rst b/docs/api-usage.rst index 190482f..925f8bb 100644 --- a/docs/api-usage.rst +++ b/docs/api-usage.rst @@ -49,7 +49,7 @@ Note on password authentication The ``/session`` API endpoint used for username/password authentication has been removed from GitLab in version 10.2, and is not available on gitlab.com -anymore. Personal token authentication is the prefered authentication method. +anymore. Personal token authentication is the preferred authentication method. If you need username/password authentication, you can use cookie-based authentication. You can use the web UI form to authenticate, retrieve cookies, @@ -195,7 +195,7 @@ To avoid useless calls to the server API, you can create lazy objects. These objects are created locally using a known ID, and give access to other managers and methods. -The following exemple will only make one API call to the GitLab server to star +The following example will only make one API call to the GitLab server to star a project: .. code-block:: python diff --git a/docs/gl_objects/events.rst b/docs/gl_objects/events.rst index 807dcad..eef524f 100644 --- a/docs/gl_objects/events.rst +++ b/docs/gl_objects/events.rst @@ -31,7 +31,7 @@ Examples You can list events for an entire Gitlab instance (admin), users and projects. You can filter you events you want to retrieve using the ``action`` and -``target_type`` attributes. The possibole values for these attributes are +``target_type`` attributes. The possible values for these attributes are available on `the gitlab documentation <https://docs.gitlab.com/ce/api/events.html>`_. diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst index b39c73b..8c87bf7 100644 --- a/docs/gl_objects/projects.rst +++ b/docs/gl_objects/projects.rst @@ -320,7 +320,7 @@ Delete a tag: Project snippets ================ -The snippet visibility can be definied using the following constants: +The snippet visibility can be defined using the following constants: * ``gitlab.VISIBILITY_PRIVATE`` * ``gitlab.VISIBILITY_INTERNAL`` diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst index 63609db..3cbea6b 100644 --- a/docs/gl_objects/users.rst +++ b/docs/gl_objects/users.rst @@ -208,19 +208,19 @@ List GPG keys for a user: :start-after: # gpgkey list :end-before: # end gpgkey list -Get an GPG gpgkey for a user: +Get a GPG gpgkey for a user: .. literalinclude:: users.py :start-after: # gpgkey get :end-before: # end gpgkey get -Create an GPG gpgkey for a user: +Create a GPG gpgkey for a user: .. literalinclude:: users.py :start-after: # gpgkey create :end-before: # end gpgkey create -Delete an GPG gpgkey for a user: +Delete a GPG gpgkey for a user: .. literalinclude:: users.py :start-after: # gpgkey delete |
