-
Notifications
You must be signed in to change notification settings - Fork 90
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
Improve docs usage links #653
base: staging
Are you sure you want to change the base?
Conversation
bb166d9
to
a38f09b
Compare
/// | ||
/// If the file doesn't exist, it returns a boolean and prints a message. | ||
/// If the file doesn't exist, it returns `false` and prints a message. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To be honest I think that functions returning a Bool
value type should be rewritten to failable equivalents if the returned Bool
means whether or not the function succeeded.
Essentially the use of Bool
should always indicate existence of certain attribute. Like for checking if something is switched on or off or ex. if a value exists in some array. In case of returning a success status, we should always return failure which gives more information about the error (different errors may have different exit codes).
But that's out of scope of this PR. I'll create an issue
Fixes the parts of #651 dealing with documentation content formatting.