`g:ctrlp_working_path_mode` wording hard to understand

[flavius]

I think the following is difficult to understand:

'a' - like 'c', but only applies when the current working directory outside of CtrlP isn't a direct ancestor of the directory of the current file.

We were a little puzzled about it on #vim @ freenode too. Could you please add a succint relevant information on the homepage [1], to make it clear and quick to understand?

[1] http://kien.github.io/ctrlp.vim/

[kien]

You have to read that description in the context of the whole option. It means ctrlp's local directory is set to the directory of the current file, unless the current file is somewhere inside the current working directory.

So which parts do you think are difficult to understand? What do you suggest to make the description clearer?

[kien]

I'm going to leave it as-is. It's not that difficult to understand once you know what each term means by reading the other settings. You need to do that anyway to know what c does, for example.

[flavius]

"outside of CtrlP" is misleading. Does CtrlP maintain its own CWD? Do you mean "outside of vim"? Do you mean cd or lcd?

It may be easy to you, as you've written it, you have "inside knowledge", but for outsiders it's not.

[kien]

Yes, "its local working directory" means ctrlp has its own cwd. This is mentioned right at the top. And "outside of ctrlp" doesn't mean "outside of vim", it means exactly "outside of ctrlp". So the cwd used here is the non-ctrlp cwd.

[flavius]

Do I have to beg for improvements in the documentation? We both like CtrlP and want it to become better. The paragraph I've mentioned is confusing - I still don't understand exactly where CtrlP starts searching. It's not clear what 'r' does, nor what the default 'ra' does. Is there any precedence rule?

Please address these issues in the documentation. Anyone would benefit from the improvement.

[kien]

I'd love to. I just honestly don't see how I can make this part any clearer. As in I don't know how. And since no one else has complaint in the past one year and a half, I'm inclined to believe that the majority of people understand it just fine.

[elmart]

I don't understand it either. The fact that not many people complain only means that most of the people doesn't take the burden to report an issue.

[kien]

My English isn't very good. If anyone cares enough to make any part of the help better, no matter how little, please go ahead and do so. Pull requests are always most welcome.

[redondos]

Pull request sent: #559