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

Documentation fixes #128

Closed
asbates opened this issue Apr 11, 2023 · 2 comments
Closed

Documentation fixes #128

asbates opened this issue Apr 11, 2023 · 2 comments
Labels

Comments

@asbates
Copy link
Contributor

asbates commented Apr 11, 2023

Documentation issues noted as part of #125 but are quite involved.

  • A number of examples use :::. We shouldn't use this.
  • merge_expression_module and merge_expression_srv use chunks.
@donyunardi
Copy link
Contributor

donyunardi commented Apr 14, 2023

I feel that the points that you made can be split into two issues.

merge_expression_module and merge_expression_srv use chunks.

Lets handle this part with #129

As for this

A number of examples use :::. We shouldn't use this.

Let's discuss this with the team first and come to an agreement since teal.transform is not only place that I see this happening, mostly internal functions.

Adding this topic to insightsengineering/nestdevs-tasks#17

asbates added a commit that referenced this issue Apr 17, 2023
Updates some documentation in preparation for release. These changes
regard examples in the roxygen docs.

There are still a few more documentation changes to be made. However
they are beyond what I can do quickly so I opened #128.

Also note there is still some chunks usage. I've opened #129 to address
this.

Fixes #125

---------

Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>
@donyunardi
Copy link
Contributor

Topics are addressed or handled in other issue for efficiency.
Closing.

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

No branches or pull requests

2 participants