libgit2 / libgit2/pygit2

"create remote" documentation

Open
#892 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.7k
Forks
408
Avg merge
2d 57m
Merged PRs (30d)
7

Description

I spent a while looking for what Remote.remotes.create() references.
https://github.com/libgit2/pygit2/blob/75d0d804303cc7bdeda48b72668000e2c58a44cf/pygit2/repository.py#L136

It seems to me that should be either Repository.remotes.create() in terms of object hierarchy when instantiated or remotes.RemoteCollection.create() in terms of definition/documentation.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue points to pygit2/repository.py around line 136; compare the Remote.remotes.create() reference with the documented object hierarchy and locate the corresponding API documentation. Correct the referenced name to match the intended hierarchy, then verify the documentation renders with the corrected path.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.