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 documentation #16

Merged
merged 13 commits into from
Mar 28, 2018
Merged

Clean up documentation #16

merged 13 commits into from
Mar 28, 2018

Conversation

lafrenierejm
Copy link
Contributor

No description provided.

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.
@ljos ljos merged commit 1fb98f9 into ljos:master Mar 28, 2018
@ljos
Copy link
Owner

ljos commented Mar 28, 2018

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants