Skip to content

Commit 2e465df

Browse files
committed
Merge pull request pyapi-gitlab#26 from Itxaka/master
updated docs
2 parents be8aa52 + 23fb1fb commit 2e465df

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/index.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@ Then we need to authenticate to our Gitlab instance. There is 2 ways of doing th
2626
Authenticating via user/password
2727
==================================
2828

29-
First create the instance passing the gitlab server as parameter, You can also pass the gitlab backend version as there are some differences
30-
between 5 and 6 (One example, when creating projects you cna make them public on gitlab 6, gitlab 5 doesn't have that option) default version is 5::
29+
First create the instance passing the gitlab server as parameter::
3130

32-
git = gitlab.Gitlab("our_gitlab_host","5")
31+
git = gitlab.Gitlab("our_gitlab_host")
3332

3433
Then call the login() method::
3534

@@ -112,13 +111,15 @@ Get project events::
112111
git.getProjectEvents(project_id)
113112

114113
Create a new project
114+
115115
If you are using version 6 you can pass an extra "public" argument which makes the project public.
116-
Please note that Gitlab 5 doesn't have this option and you have to explicity declare your version of gitlab (See the start of the docs to find how)::
116+
117+
Please note that Gitlab 5 doesn't have this option and using it will probably end in a failure while creating the project::
117118

118119
git.createProject(name, description="", default_branch="",
119-
issues_enabled="", wall_enabled="",
120-
merge_requests_enabled="", wiki_enabled="",
121-
snippets_enabled="", public="")
120+
issues_enabled=0, wall_enabled=0,
121+
merge_requests_enabled=0, wiki_enabled=0,
122+
snippets_enabled=0, public=0)
122123

123124
List project members::
124125

0 commit comments

Comments
 (0)