Skip to content

[Canvas][Docs] Updates function reference#50393

Merged
cqliu1 merged 6 commits intoelastic:masterfrom
cqliu1:docs/update-fn-ref
Nov 22, 2019
Merged

[Canvas][Docs] Updates function reference#50393
cqliu1 merged 6 commits intoelastic:masterfrom
cqliu1:docs/update-fn-ref

Conversation

@cqliu1
Copy link
Contributor

@cqliu1 cqliu1 commented Nov 12, 2019

Summary

[skip-ci]

This updates the function reference using the content generated in #49402.

Changes:

  • Fixes various typos
  • Replaces open ()/close () double quote with straight (") double quotes

Checklist

Use strikethroughs to remove checklist items you don't feel are applicable to this PR.

- [ ] This was checked for cross-browser compatibility, including a check against IE11

For maintainers

@cqliu1 cqliu1 added review Team:Docs Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas t// loe:large Large Level of Effort v8.0.0 impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. v7.5.0 v7.3.2 v7.6.0 v7.4.3 labels Nov 12, 2019
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-canvas (Team:Canvas)

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@cqliu1 cqliu1 added the release_note:skip Skip the PR/issue when compiling release notes label Nov 12, 2019
Copy link
Contributor

@KOTungseth KOTungseth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice PR! I have some small suggestions, but otherwise LGTM.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this supposed to be a question?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, some help descriptions of arguments that take a boolean value are written in the form of a question to indicate true as yes and false as no. Should we not do this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same same

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably don't need to fix in this PR, or maybe at all, but my writer brain is flagging from which. I'm not sure if we care about using British English in our docs, but from which definitely fits in the British English realm.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking these are on purpose now... if so, please ignore all of my comments.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When would I want to use a specialized function? Maybe add that information too?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably go into detail in the expression language docs instead of in this help text. Basically if I have a datatable and I want to add a render as="plot" for instance at the end, it won't work without using the specialized plot function.

@cqliu1 cqliu1 force-pushed the docs/update-fn-ref branch 5 times, most recently from bd2f9a3 to 32e6ee5 Compare November 19, 2019 19:20
@cqliu1 cqliu1 force-pushed the docs/update-fn-ref branch from 32e6ee5 to 61ab45c Compare November 22, 2019 22:09
@cqliu1 cqliu1 merged commit bcd0c09 into elastic:master Nov 22, 2019
@cqliu1 cqliu1 deleted the docs/update-fn-ref branch November 22, 2019 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:large Large Level of Effort release_note:skip Skip the PR/issue when compiling release notes review Team:Docs Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas t// v7.3.2 v7.4.3 v7.5.0 v7.6.0 v8.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants