Bug 1275990 - Document meaning of caret symbol in scoped_search
Summary: Document meaning of caret symbol in scoped_search
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Docs User Guide
Version: 6.1.0
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: Unspecified
Assignee: David O'Brien
QA Contact: Stephen Wadeley
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-10-28 10:12 UTC by Maxim Burgerhout
Modified: 2019-09-26 18:06 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-11-17 19:07:14 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Maxim Burgerhout 2015-10-28 10:12:18 UTC
Document URL: https://access.redhat.com/documentation/en-US/Red_Hat_Satellite/6.1/html-single/User_Guide/index.html

Section Number and Name: table 18.2 vs. section 15.3.3

Describe the issue: The docs for granular search describe how the caret (^) sign works in granular matching for permissions. For scoped search however, the caret is not documented even though it is auto-completed and it's meaning is different from granular search. 

Suggestions for improvement: 
Please add an example in section 15.3.3 to demonstrate the use of the caret in scoped search.

Something like

    facts.architecture ^ (x86_64,i386) 

would fit nicely with the other examples. 

Additional information: 

The caret in scoped_search means 'in', like in SQL, not 'starts with' like in regular expressions. It is confusing to not have this documented.

See: https://github.com/wvanbergen/scoped_search/blob/master/lib/scoped_search/query_language/tokenizer.rb#L10

Comment 1 David O'Brien 2015-10-28 12:46:06 UTC
I can fix this. I've already been working in this section.


Note You need to log in before you can comment on or make changes to this bug.