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

Separate functions in smaller topics + update ci #2431

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

olivroy
Copy link
Contributor

@olivroy olivroy commented Sep 1, 2024

This is to make clearer what operations do what, hence facilitate the selection of the right st_*() function.

This work will require a few iterations to continue, but thought I'd send this PR first to see if there is interest.

The end goal is to combine documentation that applies to many functions in a help topic while separating out the pieces of docs that only apply to a single function to avoid clutter in the doc.

The goal is to have multiple documentation topic and use roxygen2 tags to reuse documentation (like @inheritParams.

Also added a rough classification in the pkgdown index for #2176 (can still be improved)

Fix #2428, seems like this was just a documentation issue!
fix #2176

@olivroy olivroy changed the title Separate functions in smaller topics Separate functions in smaller topics + update ci Sep 2, 2024
@olivroy
Copy link
Contributor Author

olivroy commented Oct 30, 2024

@edzer Just a reminder! When you have time, please let me know what you think..

The goal ia to improve the prompts we get when we use autocompletion, to be able to find information more quickly by dividing topics up in more digestible pieces.

A lot of information is present already. The goal of this PR (and the follow-up ones I am planning) is to reorganize slightly by taking advantage of roxygen2 reusability features.

If you want, I can add review comments to help you follow more easily?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant