ontology-access-kit icon indicating copy to clipboard operation
ontology-access-kit copied to clipboard

Docs: `search`: regex / operators clarification

Open joeflack4 opened this issue 2 years ago • 1 comments

Overview

I was reading through https://incatools.github.io/ontology-access-kit/intro/tutorial01.html#search and also compared against https://incatools.github.io/ontology-access-kit/cli.html#runoak-search, and in the former, there are some syntax that you can use, like ^, and ~, as well as / for full regex, but that is not mentioned in the CLI command docs. Just wondering if: (i) it should be, (ii) if what I mentioned here was an exhaustive list, or if there are more.

As I look through the docs more, I see that the guide is naturally more thorough than the CLI reference. I think it makes sense for the guide to have more examples and exposition, but I do think things like options and syntax probably ought to be in the CLI reference as well.

joeflack4 avatar Jul 17 '23 23:07 joeflack4

Good catch! The search syntax is powerful but the documentation is not well organized

On Mon, Jul 17, 2023 at 4:59 PM Joe Flack @.***> wrote:

Overview

I was reading through https://incatools.github.io/ontology-access-kit/intro/tutorial01.html#search and also compared against https://incatools.github.io/ontology-access-kit/cli.html#runoak-search, and in the former, there are some special regex-like syntax that you can use, like ^, and ~, but that is not mentioned in the CLI command docs. Just wondering if: (i) it should be, (ii) if ^ and ~ is an exhaustive list, or if there are more.

— Reply to this email directly, view it on GitHub https://github.com/INCATools/ontology-access-kit/issues/614, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAMMOLWS2DWONNS6G74FVTXQXGWDANCNFSM6AAAAAA2NT4I64 . You are receiving this because you are subscribed to this thread.Message ID: @.***>

cmungall avatar Jul 18 '23 00:07 cmungall