-
Notifications
You must be signed in to change notification settings - Fork 6
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 documentation #16
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reference the GOAL parameter correctly in the docstring. Remove the unnecessary and potentially confusing specification that GOAL is a Prolog goal.
Correctly reference the BODY and PARAMS parameters. Move the information about the function calling to a separate paragraph.
Move the second sentence of the docstring to its own paragraph. Correct a typo in and modify the grammar of the second sentence.
Move the second sentence to its own paragraph. Change the structure of the second sentence to clarify its meaning.
Adhere to docstring convention by including entire first sentence on a single line. Use the second sentence (in its own paragraph) to describe the function's behavior if SESSION is not initialized prior to calling the function.
Correct the description of the function's actions. Indicate that the BODY and PARAMS parameters are unused.
Thank you for improving the documentation of ob-prolog! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.