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

Refactoring documentation of class methods #142

Open
Melkiades opened this issue Apr 28, 2023 · 1 comment
Open

Refactoring documentation of class methods #142

Melkiades opened this issue Apr 28, 2023 · 1 comment
Labels
discussion Needs to consider if worth it or how documentation Improvements or additions to documentation enhancement New feature or request sme Tracks changes for the sme board

Comments

@Melkiades
Copy link
Contributor

I have had this in mind for a bit as I often found myself lost in search of methods to, e.g., count the total number of printed lines (not nrow) of a specific table (see #119). I am also aware of others that have similar problems. It could also be a problem of how I reach the documentation as I could not find any better way to retrieve the documentation page of nrow() for VTableTree if not by calling ?nrow,VTableTree-method``. Is there a better way?

All of this is still a working in progress as I came to this by trying to find documentation for the print method for VTableTree to do something similar to what I did in insightsengineering/rlistings#113 which surfaces a bit of the printing machinery by referencing a couple of relevant parameters.

@Melkiades Melkiades added documentation Improvements or additions to documentation enhancement New feature or request discussion Needs to consider if worth it or how sme Tracks changes for the sme board labels Apr 28, 2023
@gmbecker
Copy link
Collaborator

In general you often shouldn't be searching for individual methods as an end user. Sometimes you need them but much much more often what you actually need is the documentation of the generic, so please do not do more work on this before we talk about it and what exactly you mean by refactoring @Melkiades

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Needs to consider if worth it or how documentation Improvements or additions to documentation enhancement New feature or request sme Tracks changes for the sme board
Projects
None yet
Development

No branches or pull requests

2 participants