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

Create docs for each class #35

Closed
rcannood opened this issue Oct 11, 2024 · 1 comment
Closed

Create docs for each class #35

rcannood opened this issue Oct 11, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@rcannood
Copy link
Collaborator

@lazappi already filled in some documentation for the classes.

Let's remove the @noRd in each (/most?) of the Rd classes.

Of course, the classes won't have all of the fields that the user will want to use. For instance, in the documentation of Instance it should be noted that an instance will contain the core data structures, e.g. db$Artifact, and that these are objects of class Registry.

@rcannood rcannood added the documentation Improvements or additions to documentation label Oct 17, 2024
@rcannood
Copy link
Collaborator Author

Implemented in #36

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

No branches or pull requests

1 participant