Skip to content

Commit

Permalink
docs: clarify compound extension signature naming for bools (#545)
Browse files Browse the repository at this point in the history
#537 clarified that compound extension signatures are now required.
I noticed that the table specifying how to type those signatures didn't 
include booleans -- I _think_ it's probably `bool` but either way it 
should be included.

Also in this PR, a quick indentation fix so that the `Note:` admonitions
render correctly (there needs to be blank line and then an indented
block)
  • Loading branch information
gforsyth authored Aug 21, 2023
1 parent 31b9990 commit 8969a40
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
5 changes: 3 additions & 2 deletions site/docs/extensions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ A YAML file may contain one or more functions by the same name. The key used in

Rather than using a full data type representation, the input argument types (`short_arg_type`) are mapped to single-level short name. The mappings are listed in the table below.

!!! note
!!! note

Every compound function signature must be unique. If two function implementations in a YAML file would generate the same compound function signature, then the YAML file is invalid and behavior is undefined.
Every compound function signature must be unique. If two function implementations in a YAML file would generate the same compound function signature, then the YAML file is invalid and behavior is undefined.

| Argument Type | Signature Name |
| -------------------------- | -------------- |
Expand All @@ -48,6 +48,7 @@ Every compound function signature must be unique. If two function implementatio
| fp64 | fp64 |
| string | str |
| binary | vbin |
| boolean | bool |
| timestamp | ts |
| timestamp_tz | tstz |
| date | date |
Expand Down
6 changes: 4 additions & 2 deletions site/docs/serialization/binary_serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,12 @@ Once the YAML file URI anchor is defined, the anchor will be referenced by zero
```

!!! note
Anchors only have meaning within a single plan and exist simply to reduce plan size. They are not some form of global identifier. Different plans may use different anchors for the same specific functions, types, type variations, etc.

Anchors only have meaning within a single plan and exist simply to reduce plan size. They are not some form of global identifier. Different plans may use different anchors for the same specific functions, types, type variations, etc.

!!! note
It is valid for a plan to include `SimpleExtensionURI`s and/or `SimpleExtensionDeclaration`s that are not referenced directly.

It is valid for a plan to include `SimpleExtensionURI`s and/or `SimpleExtensionDeclaration`s that are not referenced directly.



Expand Down

0 comments on commit 8969a40

Please sign in to comment.