Skip to content

Conversation

@LoricAndre
Copy link
Contributor

Checklist

check the box if it is not applicable to your changes

  • I have updated the README with the necessary documentation
  • I have added unit tests
  • I have added end-to-end tests
  • I have linked all related issues or PRs

Description of the changes

@LoricAndre
Copy link
Contributor Author

@not-my-profile could you take a look at this and tell me if it seems good to you ? Please tell me if anything is still unclear to you, this part of the documentation is really lacking at the moment and this is a good opportunity to better it.

@not-my-profile
Copy link

It's still not clear to me why -i and -c are separate and also what happens when you do -i without -c.

@LoricAndre
Copy link
Contributor Author

How is this ?

@not-my-profile
Copy link

not-my-profile commented Jun 22, 2025

I think all the available modes should be explained at the top of the man page after:

sk is a general purpose command-line fuzzy finder.

and before the ENVIRONMENT VARIABLES. Then the CLI flags can refer to that explanation.

And there it would be important to mention what the default mode is.

@LoricAndre
Copy link
Contributor Author

That's a good idea ! Please take a look when you can and tell me what you think.

@not-my-profile
Copy link

Btw I think you have to move the "closes #805" into the commit message body, I don't think GitHub recognizes it in the title.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants