Skip to content

editorconfig

Accessed as client.repos.editorconfig; the async client mirrors it.

ReposEditorconfig

The repos.editorconfig namespace.

get

get(owner: str, repo: str, filepath: str, *, ref: str | None = None) -> dict[str, str]

Get the EditorConfig definitions of a file in a repository.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
filepath str

filepath of file to get

required
ref str | None

The name of the commit/branch/tag. Default the repository's default branch (usually master)

None

Returns:

Type Description
dict[str, str]

definitions.

Raises:

Type Description
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: repoGetEditorConfig

AsyncReposEditorconfig

The repos.editorconfig namespace.

get

get(owner: str, repo: str, filepath: str, *, ref: str | None = None) -> dict[str, str]

Get the EditorConfig definitions of a file in a repository.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
filepath str

filepath of file to get

required
ref str | None

The name of the commit/branch/tag. Default the repository's default branch (usually master)

None

Returns:

Type Description
dict[str, str]

definitions.

Raises:

Type Description
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: repoGetEditorConfig