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 #120

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

Refactoring documentation of class methods #120

Melkiades opened this issue Apr 28, 2023 · 1 comment
Labels
discussion documentation Improvements or additions to documentation enhancement New feature or request sme

Comments

@Melkiades
Copy link
Contributor

Melkiades commented Apr 28, 2023

"Methods for listing_df objects" is the documentation page that can be retrieved from print.listing_df. I think there some methods belong to different contexts, e.g. decoration and printing. It has been frustrating at times to get these documentation pages and difficult to understand essential development aspects like the fact that print is essential cat(toString()). This can be largely improved by grouping and extending the documentation, as many of these are directly called by users.

This is more relevant in formatters as the number of internal methods for S4 objects is quite extensive. see: insightsengineering/formatters#142

@Melkiades Melkiades added enhancement New feature or request sme discussion documentation Improvements or additions to documentation labels Apr 28, 2023
@shajoezhu
Copy link
Collaborator

I think we can close this issue here. This should live inside for formatters

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion documentation Improvements or additions to documentation enhancement New feature or request sme
Projects
None yet
Development

No branches or pull requests

2 participants