Expand documentation on exporting Spicy types #252
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
rsmmr
reviewed
Mar 11, 2024
bbannier
force-pushed
the
topic/bbannier/spicy-export
branch
from
8e63eef to
fc46532
Compare
rsmmr
approved these changes
Mar 12, 2024
Comment on lines
+615
to
+620
| export SPICY_ID [with { [SIPCY_FIELD_NAME [&log], ]... }]; | ||
| export SPICY_ID [as ZEEK_ID [ with { [SIPCY_FIELD_NAME [&log], ]...] }]; | ||
| export SPICY_ID [without { [SIPCY_FIELD_NAME, ]... }]; | ||
| export SPICY_ID [as ZEEK_ID [ without { [SIPCY_FIELD_NAME, ]...] }]; | ||
| export SPICY_ID &log; | ||
| export SPICY_ID as ZEEK_ID &log; |
There was a problem hiding this comment.
I'd still try to compress this into a single line but may be matter of taste.
There was a problem hiding this comment.
That's what I initially tried, but it always overflowed the box in the rendered pages so it required horizontal scrolling, and also required a lot of nesting. I was unsure whether adding line breaks for readability would be confusing to readers. The full expression was
export SPICY_ID [&log | with { [SPICY_FIELD_NAME [&log], ]...} | without { [SPICY_FIELD_NAME, ]... } | as ZEEK_ID [&log | { [SPICY_FIELD_NAME [&log], ]...} | without { [SPICY_FIELD_NAME, ]...}]]
There was a problem hiding this comment.
I'd still try to compress this into a single line but may be matter of taste.
How about this:
export SPICY_ID [as ZEEK_ID] [with/without { SPICY_FIELD_NAME [&log], ...}] [&log]
The field &log isn't 100% correct (doesn't apply to without), but seems good enough?
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.
No description provided.