Bug 1275990 - Document meaning of caret symbol in scoped_search
Document meaning of caret symbol in scoped_search
Status: CLOSED CURRENTRELEASE
Product: Red Hat Satellite 6
Classification: Red Hat
Component: Docs User Guide (Show other bugs)
6.1.0
Unspecified Unspecified
unspecified Severity medium (vote)
: Unspecified
: 6.1
Assigned To: David O'Brien
Stephen Wadeley
:
Depends On:
Blocks:
  Show dependency treegraph
 
Reported: 2015-10-28 06:12 EDT by Maxim Burgerhout
Modified: 2015-11-17 14:07 EST (History)
1 user (show)

See Also:
Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
Environment:
Last Closed: 2015-11-17 14:07:14 EST
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---


Attachments (Terms of Use)

  None (edit)
Description Maxim Burgerhout 2015-10-28 06:12:18 EDT
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 08:46:06 EDT
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.