Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

functions documentation #953

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Conversation

NamanChhabra
Copy link
Contributor

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link
Collaborator

@cfjedimaster cfjedimaster left a comment

Choose a reason for hiding this comment

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

I'm not sure what the point is of showing the $string call to display an array. In most cases, folks would want to display: X, Y, Z. Not ["X", "Y", "Z"]. Why not document how that would be done?

@cfjedimaster
Copy link
Collaborator

I'd maybe show $join instead: https://docs.jsonata.org/string-functions#join

@NamanChhabra
Copy link
Contributor Author

https://docs.jsonata.org/string-functions#join

this will be the case when we have array as the value of a key in json and the user wants to print that value as array itself.
Also , there are some functions that have an output type of array so to print them we can use the $string() function.

@cfjedimaster
Copy link
Collaborator

I guess I can see that as something a person would do, but most humans don't 'read' arrays like that, and the consumers of the PDFs are probably more non-technical folks. I'm not saying this isn't a bad tip per se, but it just feels odd for us to show a random tip like this. I do think our docs could use a page with DocGen tips and tricks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants