Skip to content

Fix typos in documentation #446

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.

Sign up for GitHub

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
Mar 3, 2018
Merged

Fix typos in documentation #446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions ChangeLog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Version 1.2.0_ - 2018-01-01
* Add support for impersonation tokens API
* Add support for user activities
* Update user docs with gitlab URLs
* [docs] Bad arguments in projetcs file documentation
* [docs] Bad arguments in projects file documentation
* Add support for user_agent_detail (issues)
* Add a SetMixin
* Add support for project housekeeping
Expand Down Expand Up @@ -464,7 +464,7 @@ Version 0.9.1_ - 2015-05-15
Version 0.9_ - 2015-05-15
--------------------------

* Implement argparse libray for parsing argument on CLI
* Implement argparse library for parsing argument on CLI
* Provide unit tests and (a few) functional tests
* Provide PEP8 tests
* Use tox to run the tests
Expand Down Expand Up @@ -537,9 +537,9 @@ Version 0.3_ - 2013-08-27
--------------------------

* Use PRIVATE-TOKEN header for passing the auth token
* provide a AUTHORS file
* provide an AUTHORS file
* cli: support ssl_verify config option
* Add ssl_verify option to Gitlab object. Defauls to True
* Add ssl_verify option to Gitlab object. Defaults to True
* Correct url for merge requests API.

Version 0.2_ - 2013-08-08
Expand Down
2 changes: 1 addition & 1 deletion RELEASE_NOTES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Changes from 0.21 to 1.0.0
by default.

v4 is mostly compatible with the v3, but some important changes have been
introduced. Make sure to read `Switching to GtiLab API v4
introduced. Make sure to read `Switching to GitLab API v4
<http://python-gitlab.readthedocs.io/en/master/switching-to-v4.html>`_.

The development focus will be v4 from now on. v3 has been deprecated by GitLab
Expand Down
4 changes: 2 additions & 2 deletions docs/api-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/gl_objects/events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>`_.

Expand Down
2 changes: 1 addition & 1 deletion docs/gl_objects/projects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
6 changes: 3 additions & 3 deletions docs/gl_objects/users.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down