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

clean up documentation for linear_pool and linear_pool_quantile #100

Closed
2 tasks done
elray1 opened this issue Mar 28, 2024 · 0 comments · Fixed by #107
Closed
2 tasks done

clean up documentation for linear_pool and linear_pool_quantile #100

elray1 opened this issue Mar 28, 2024 · 0 comments · Fixed by #107
Assignees

Comments

@elray1
Copy link
Contributor

elray1 commented Mar 28, 2024

Two items here:

  • The docstrings for the task_id_cols parameter of these functions reference "the specified output_type_col and output_type_id_col", but those are not parameters of these functions. If we think we need them, should we add them? Otherwise, let's remove references to them from this documentation.
  • There is a bunch of duplicated text in the documentation for these two functions (many of the function arguments are the same). It would be easier to maintain this if we used magical roxygen things to reuse the documentation. For example, that would make it so we only had to update the documentation for the task_id_cols parameter in one place.
@lshandross lshandross linked a pull request Apr 18, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging a pull request may close this issue.

2 participants