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.

Sign up for GitHub

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

Jump to bottom

Minor doc point. #5

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

Minor doc point. #5

ablaom opened this issue Aug 13, 2023 · 0 comments

Comments

@ablaom
Copy link
Member

ablaom commented Aug 13, 2023

https://github.com/pebeto/MLJFlow.jl/blob/951fb8f8b03727ec2539b8e9ec832cf44503d345/src/types.jl#L11

To keep doc strings concise, I usually suppress statements like "If the client is not running an informative error will be thrown". The user will find this out if they forget. Otherwise, they don't need this information.
@pebeto pebeto closed this as completed Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pebeto @ablaom