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.

Sign up for GitHub

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

Jump to bottom

Standardize the notation for optional parameters in documentation #52

Closed
6 of 14 tasks
kartikeyakirar opened this issue Feb 23, 2024 · 5 comments
Closed
6 of 14 tasks

Standardize the notation for optional parameters in documentation #52

kartikeyakirar opened this issue Feb 23, 2024 · 5 comments
Assignees
@kartikeyakirar
Labels
core documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@kartikeyakirar
Copy link

kartikeyakirar commented Feb 23, 2024 •
edited by m7pr
Loading

In our ongoing efforts to maintain consistency across our documentation, particularly within Nest packages it has become apparent that we need to align on a standardized way to indicate optional parameters in our documentation. This issue arises from our discussion here.

Currently, @averissimo identified various formats in use across different packages, as follows:

@param optional (character) ...
@param (optional character) ...
@param (character, optional) ...
@param (character) optional ...

The suggested format, based on our collective insights, is @param (character) optional ....

Changes to be done here
@kartikeyakirar kartikeyakirar added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers core labels Feb 23, 2024
@kartikeyakirar kartikeyakirar mentioned this issue Feb 23, 2024
Merged
@m7pr
Copy link

m7pr commented Feb 26, 2024

@gogonzo @donyunardi @vedhav just informing you, in case you missed arrangements in insightsengineering/teal.modules.general#646 (comment)

@kartikeyakirar kartikeyakirar mentioned this issue Feb 28, 2024
Merged
@m7pr
Copy link

m7pr commented Feb 28, 2024

Hey guys, we had a chat in here insightsengineering/teal.modules.general#698 (comment) and I believe for situations like

optional specifies font size

that are not grammatically correct, we need to put , after optional so it's

optional, specifies font size

@m7pr
Copy link

m7pr commented Feb 28, 2024

So it's probably gonna be @param (class) optional, ... in most of the places

@kartikeyakirar kartikeyakirar self-assigned this Mar 4, 2024
This was referenced Mar 5, 2024
Merged
Merged
Merged
Merged
Merged
Merged
Merged
kartikeyakirar added a commit to insightsengineering/teal.widgets that referenced this issue Mar 14, 2024
@kartikeyakirar @m7pr
52 standardise optional notation (#231)
f7e50ec 
part of insightsengineering/nestdevs-tasks#52

- update Roxygen tags
- standardise optional notation

---------

Signed-off-by: kartikeya kirar <[email protected]>
Co-authored-by: Marcin <[email protected]>
kartikeyakirar added a commit to insightsengineering/teal.osprey that referenced this issue Mar 14, 2024
@kartikeyakirar @dependabot-preview @m7pr
52 standardise optional notation (#260)
63abc2a 
part of insightsengineering/nestdevs-tasks#52

- standardise optional notation 
- updated roxygen tags

---------

Signed-off-by: kartikeya kirar <[email protected]>
Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>
Co-authored-by: m7pr <[email protected]>
Co-authored-by: Marcin <[email protected]>
kartikeyakirar added a commit to insightsengineering/teal.transform that referenced this issue Mar 14, 2024
@kartikeyakirar @m7pr @dependabot-preview
52 standardise optional notation (#204)
d0e573e 
part of insightsengineering/nestdevs-tasks#52

---------

Signed-off-by: kartikeya kirar <[email protected]>
Co-authored-by: Marcin <[email protected]>
Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>
kartikeyakirar added a commit to insightsengineering/teal.data that referenced this issue Mar 14, 2024
@kartikeyakirar @m7pr @dependabot-preview
52 standardise optional notation (#302)
baf8b94 
part of insightsengineering/nestdevs-tasks#52

---------

Signed-off-by: kartikeya kirar <[email protected]>
Co-authored-by: Marcin <[email protected]>
Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>
kartikeyakirar added a commit to insightsengineering/teal.slice that referenced this issue Mar 14, 2024
@kartikeyakirar @m7pr @dependabot-preview
52 standardise optional notation (#567)
a8b89a9 
part of insightsengineering/nestdevs-tasks#52

---------

Signed-off-by: kartikeya kirar <[email protected]>
Co-authored-by: Marcin <[email protected]>
Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>
kartikeyakirar added a commit to insightsengineering/teal.modules.clinical that referenced this issue Mar 14, 2024
@kartikeyakirar @dependabot-preview
52 standardise optional notation (#1094)
3bf14e4 
part of insightsengineering/nestdevs-tasks#52

---------

Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>
kartikeyakirar added a commit to insightsengineering/teal that referenced this issue Mar 15, 2024
@kartikeyakirar @dependabot-preview @chlebowa
52 standardise optional notation (#1121)
06effc5 
part of insightsengineering/nestdevs-tasks#52

---------

Signed-off-by: kartikeya kirar <[email protected]>
Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>
Co-authored-by: Aleksander Chlebowski <[email protected]>
@pawelru
Copy link
Collaborator

pawelru commented Apr 19, 2024

Hey @kartikeyakirar. It looks like every package that requires action had been done. Can we close it?

@kartikeyakirar
Copy link
Author

Yes

@pawelru pawelru mentioned this issue Aug 13, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kartikeyakirar kartikeyakirar

Labels
core documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kartikeyakirar @pawelru @m7pr