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

Folding roxygen2 comments #3694

Open
ngreifer opened this issue Oct 17, 2018 · 5 comments
Open

Folding roxygen2 comments #3694

ngreifer opened this issue Oct 17, 2018 · 5 comments

Comments

@ngreifer
Copy link

I'm using roxygen2 to document my packages. A feature of roxygen2 is that the roxygen comments must be in the same file as the function they are documenting. This adds clutter to my code, especially when I have multiple functions and roxygen documentation comments in the same .R file.

I'm wondering if it would be possible to have code folding operate on roxygen comment blocks so they can be folded away and thereby not clutter the scripting workspace. I'm imagining it would work similar to how folding occurs around {...}, where the open brace marks the beginning of a folding section, but instead a roxygen comment would be the indicator. If implemented, it would be nice if the Folding option in the Edit dropdown would include these folded elements as well.

Thank you!

@ronblum
Copy link
Contributor

ronblum commented Dec 10, 2018

@ngreifer Thank you for the suggestion! We'll review and consider it as we continue developing RStudio.

@stale
Copy link

stale bot commented Feb 5, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs, per https://github.com/rstudio/rstudio/wiki/Issue-Grooming. Thank you for your contributions.

@stale stale bot added the stale Issues which have been closed automatically due to inactivitiy. label Feb 5, 2021
@stale
Copy link

stale bot commented Feb 19, 2021

This issue has been automatically closed due to inactivity.

@stale stale bot closed this as completed Feb 19, 2021
@karlmakepeace
Copy link

Possible in 2022? Not yet (February) it seems.

@ronblum
Copy link
Contributor

ronblum commented Feb 18, 2022

@karlmakepeace I'll reopen the issue, since you've raised that there's still interest in this. Unfortunately, I can't provide an answer and when this might be done. However, one way in which we prioritize requests is by the number of upvotes we get in the original post. It looks like there are currently ten. You can even recruit more folks to upvote this request—the more upvotes this gets, the more likely it is to be implemented!

@ronblum ronblum reopened this Feb 18, 2022
@ronblum ronblum removed the stale Issues which have been closed automatically due to inactivitiy. label Feb 18, 2022
@mikebessuille mikebessuille added this to the 2023 milestone Jun 6, 2022
@ronblum ronblum modified the milestones: Backlog-3, Later Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants