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

Link together the check_* family #68

Closed
DominiqueMakowski opened this issue Jun 19, 2019 · 9 comments · Fixed by #570
Closed

Link together the check_* family #68

DominiqueMakowski opened this issue Jun 19, 2019 · 9 comments · Fixed by #570
Assignees
Labels
Docs 📚 Something to be adressed in docs and/or vignettes

Comments

@DominiqueMakowski
Copy link
Member

DominiqueMakowski commented Jun 19, 2019

That is something we rarely use in the docstring, the "seealso" field. In that case, however, it could be useful to have all the check_* functions linked to one another, so that the user can discover and jump from function docs to function docs.

This could also be implemented via a paragraph in the details.

Aside from that, these functions are great and will necessitate a blogpost (and a vignette?) sooner or later ☺️

@strengejacke
Copy link
Member

strengejacke commented Jun 24, 2019

Aside from that, these functions are great and will necessitate a blogpost (and a vignette?) sooner or later

True, I wish I would have more time to write down at least a blog post... I think performance is a package of high usefuleness for many users, but doesn't have the popularity it probably deserve.

@DominiqueMakowski
Copy link
Member Author

patience you must have. It'll come ☺️ I think after performance is out and report at least fixed, I'll try to write some posts :)

@strengejacke
Copy link
Member

You mean parameters, not performance?

@DominiqueMakowski
Copy link
Member Author

parameters* yup but it's ok as you read my mind 🔮

@strengejacke strengejacke added the Docs 📚 Something to be adressed in docs and/or vignettes label Dec 18, 2019
@IndrajeetPatil
Copy link
Member

I think performance is a package of high usefuleness for many users, but doesn't have the popularity it probably deserve.

That aged poorly 😅

Yes, we can cross-link documentation files with @seealso and @family tags.

@IndrajeetPatil
Copy link
Member

Thankfully, this is already the case of the pkgdown website, but I guess a number of users might be discovering functions via manual and help pages. The Rd tags will definitely be helpful for them to discover other checks.

Screenshot 2021-07-02 at 16 39 04

@strengejacke
Copy link
Member

How does @family work?

@mattansb
Copy link
Member

mattansb commented Apr 4, 2023

I use it a lot in effectsize - https://github.com/easystats/effectsize/blob/main/R/cohens_d.R#L49

@strengejacke
Copy link
Member

And what does it do in the docs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs 📚 Something to be adressed in docs and/or vignettes
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants