Skip to content

Repository.init should accept boolean value for is_bare #538

Closed

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.

Activity

  1. tbranyen commented on Apr 13, 2015

    @tbranyen
    Member

    Yup! We're aware of this issue: #383. It's not trivial, but we'll hopefully get it added in eventually as it's rather confusing.

  2. tbranyen commented on Apr 20, 2015

    @tbranyen
    Member

    Closing as duplicate

  3. ylecuyer commented on Aug 15, 2018

    @ylecuyer

    I ran into this issue although it has been closed a long time ago

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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