Skip to content

Repository.init should accept boolean value for is_bare #538

@ivantm

Description

@ivantm

The docs for the is_bare param of Repository.init read:

if true, a Git repository without a working directory is created at the pointed path. If false, provided path will be considered as the working directory into which the .git directory will be created.

Yet the type of is_bare is expected to be a Number. Passing a boolean leads to an error: [Error: Number is_bare is required.].

Having the docs refer to true and false when the expected type is a Number seems incongruous, especially if the value of the number has no impact on the outcome (other than the whether the number is truthy or falsy). If the value of the number does matter, please update the docs to refer to numbers; otherwise I'd expect the function to be able to accept a boolean.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions