clarify filter SCAN_DATE docs #257
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -120,8 +120,8 @@ module Field | |||
|
|
|||
| # Search based on the last scan date of an asset. | |||
| # Valid Operators: ON_OR_BEFORE, ON_OR_AFTER, BETWEEN, EARLIER_THAN, WITHIN_THE_LAST | |||
| # Valid Values: Use Value::ScanDate::FORMAT for date arguments. | |||
| # Use FixNum for day arguments. | |||
| # Valid Values: Use FixNum for EARLIER_THAN and WITHIN_THE_LAST. | |||
There was a problem hiding this comment.
Should probably explain why it needs to be a fixnum instead of a date value since it's not spelled out otherwise in the code docs. Just to give a little extra help to newcomers to this stuff.
There was a problem hiding this comment.
You're right. Updated.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
No code changes, just comments.
Motivation and Context
This is meant to clarify some doc-strings which I found confusing.
See #256
Checklist: