Skip to content

Conversation

@vedhav
Copy link
Contributor

@vedhav vedhav commented Feb 27, 2024

Closes #684

Changes:

Titles now follow this format:

`teal` module: Function title

Additionally, moved the function params alpha and size to shared_params as they were used in 3 places.
Note that the tm_g_bivariate() uses size param with a different meaning. We might want to think about function arg standardization in the future.

@vedhav vedhav added documentation Improvements or additions to documentation core labels Feb 27, 2024
@averissimo averissimo self-assigned this Feb 27, 2024
@vedhav vedhav requested a review from averissimo February 27, 2024 13:04
@vedhav vedhav mentioned this pull request Feb 27, 2024
26 tasks
Copy link
Contributor

@averissimo averissimo left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@vedhav vedhav merged commit 5fe302b into pre-release@main Feb 27, 2024
@vedhav vedhav deleted the 684-standardise-func-titles@main branch February 27, 2024 14:21
averissimo added a commit that referenced this pull request Feb 28, 2024
…tions_process@pre-release@main

* origin/pre-release@main:
  removed @nord tags and added return from shared_params
  missing comma
  641 non exported functions (#680)
  pre-release vignettes review (#681)
  [skip roxygen] [skip vbump] Roxygen Man Pages Auto Update
  Standardise function titles similar to what we have in tmc (#691)
  [skip actions] Bump version to 0.2.16.9026
  `tm_g_regression` labels are no longer allowed out of bounds (#675)
  [skip actions] Bump version to 0.2.16.9025
  Remove the internal function `var_labels` in favour of `teal.data::col_labels` (#690)
  [skip actions] Bump version to 0.2.16.9024
  Fix the silent error in `tm_a_pca` (#688)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Update the function doc titles to use the same format that we use in tmc

4 participants