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

Clean up doc string #3

Closed
ablaom opened this issue Aug 7, 2023 · 0 comments
Closed

Clean up doc string #3

ablaom opened this issue Aug 7, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ablaom
Copy link
Member

ablaom commented Aug 7, 2023

https://github.com/pebeto/MLJFlow.jl/blob/70e961e9244645b4dfc52a99eab06aea0852f0b1/src/types.jl#L9

The first part of the docstring should address the casual user. So your "Fields" section should not mention client at all (this is part of the implementation, not the user interface) and somewhere you should explain the meaning of the baseuri argument.

(Implementation details generally go in code comments, unless you are providing a method that is part of a public interface, such as our log_evaluation method, in which case put that at the end, possibly under a separate "New implementations" section.)

@pebeto pebeto added the documentation Improvements or additions to documentation label Aug 12, 2023
@pebeto pebeto self-assigned this Aug 12, 2023
@pebeto pebeto closed this as completed Aug 12, 2023
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

2 participants