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

fix documentation for modules #1032

Closed
chlebowa opened this issue Jan 9, 2024 · 2 comments · Fixed by #1053
Closed

fix documentation for modules #1032

chlebowa opened this issue Jan 9, 2024 · 2 comments · Fixed by #1053
Assignees
@m7pr
Labels
core documentation Improvements or additions to documentation

Comments

@chlebowa
Copy link
Contributor

chlebowa commented Jan 9, 2024

Argument descriptions are wrong.

image
@chlebowa chlebowa added documentation Improvements or additions to documentation core labels Jan 9, 2024
@donyunardi donyunardi mentioned this issue Jan 9, 2024
Closed
36 tasks
@chlebowa
Copy link
Contributor Author

related: #942

@m7pr m7pr self-assigned this Jan 18, 2024
@m7pr m7pr mentioned this issue Jan 18, 2024
Merged
m7pr added a commit that referenced this issue Jan 25, 2024
@m7pr @github-actions @chlebowa
1032 fix ellipsis documentation for teal::modules() (#1053)
f216a46 
Close #1032 

Issue appeared because there is multiple function having the same
parameter being documented in one documentation page. The last
appearance of `@param` took precedence and overwritten any other text/

The idea is to have one entry for `@param ...` explaining usage for
different functions.

<img width="574" alt="image"
src="https://github.com/insightsengineering/teal/assets/133694481/079cfb70-7733-4951-b14c-305f2bd36c2a">


The drawback of the solution is that `@param ...` is not not documented
near `print` nor `toString` functions.
We could either 
- leave it as it is (with this PR fixing documentation)
- move all parameters to one place
- leave `@param ...` entries next to `print` and `toString` functions
but without `@` tag, so they are treated as comments.

---------

Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Aleksander Chlebowski <114988527+chlebowa@users.noreply.github.com>
@m7pr
Copy link
Contributor

m7pr commented Jan 26, 2024

Closed with #1073 and #1053

@m7pr m7pr closed this as completed Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@m7pr m7pr

Labels
core documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

1032 fix ellipsis documentation for teal::modules() insightsengineering/teal
2 participants
@chlebowa @m7pr