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

Minor documentation fixes #78

Open
cosmocracy opened this issue Jan 29, 2021 · 2 comments
Open

Minor documentation fixes #78

cosmocracy opened this issue Jan 29, 2021 · 2 comments

Comments

@cosmocracy
Copy link

cosmocracy commented Jan 29, 2021

Collecting notes on a few minor documentation/wording fixes and corrections. (I would be happy to fork a documentation repo if there is one.) Make the following minor documentation fixes:

In "Simple rules" section:

  • Change "own" to "our" in "An easy way to investigate what own rule found is this..." so it reads "An easy way to investigate what our rule found is this..."

In "Taking an action" section:

  • Change "if" to "is" in "...whenever the bottom of the matcher list if reached..." so it reads "...whenever the bottom of the matcher list is reached..."

In "More facts!" section:

  • Change "creates" to "asserts" in "...gen is an action that creates new facts..." so it reads "...gen is an action that asserts new facts..."
  • Change "actions" to "facts in rule actions" in "Generated actions can trigger other rules" so it reads "Generated facts in rule actions can trigger other rules"

In "Matchers" section:

  • Change "make say" to "make sense" in "because it doesn't make say to say" so it reads "because it doesn't make sense to say"

In "Actions" section:

  • Change heading of "Collect" to "Collection" to match the method name
  • I'm not sure the method signature of this is fully explained... (e.g., what is collection_name?)
@ulfurinn
Copy link
Owner

The documentation is in the gh-pages-src branch, but its dependencies are so old, I'm having trouble installing them. Might have to start with a fresh template.

@ulfurinn
Copy link
Owner

You can just make the changes to markdown until I figure out how to re-publish.

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

No branches or pull requests

2 participants