Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add gitworktree to ls-file-collection's docstring #471

Merged
merged 3 commits into from
Oct 5, 2023

Conversation

mslw
Copy link
Collaborator

@mslw mslw commented Oct 4, 2023

This PR will include gitworktree among the available file collection types listed in ls-file-collection's docstring. Fixes #470

The proposed docstring favours brevity, but does not cover nuances which could be included:

  • hash being required for size to be reported
  • reporting being based on git ls-files --stage --cached --exclude-standard --others

This adds a description of "gitworktree" as one of the available file
collection types.
This changes "(item identifiers are) the name of a file" to "... the
names of items", both to make things consistently plural, and to
reflect the fact that the identifiers can be names (actually, paths)
of directories, not just files.
@mslw mslw requested a review from mih as a code owner October 4, 2023 16:14
@mslw mslw changed the title Docstring lsfc Add gitworktree to ls-file-collection's docstring Oct 4, 2023
Copy link
Member

@mih mih left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thx!

At some point we need to think about limiting the number of text copies.

@mih mih added the semver-patch PR implies patch-level version increment (API stable) label Oct 5, 2023
@mih mih merged commit c64978b into datalad:main Oct 5, 2023
5 checks passed
@mih mih added this to the 1.0.1 milestone Oct 16, 2023
@mslw mslw deleted the docstring-lsfc branch January 12, 2024 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver-patch PR implies patch-level version increment (API stable)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ls_file_collection docstring does not mention all supported collections
2 participants