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

improve rule docs #84

Merged
merged 1 commit into from
Jan 28, 2021
Merged

improve rule docs #84

merged 1 commit into from
Jan 28, 2021

Conversation

rafaqz
Copy link
Member

@rafaqz rafaqz commented Jan 26, 2021

Description

Documentation for rule constructors and keyword arguments, and cleanup of old docs and doc workflows.

The examples are still broken because some media files are missing that they need. Will fix examples in another PR.

Changes :

  • New formulation/rule
  • Documentation
  • Bug fix for existing rules (non-breaking syntax)
  • Major change to existing rules (breaking syntax, needs a breaking version bump)

@rafaqz
Copy link
Member Author

rafaqz commented Jan 27, 2021

@jamesmaino I'm keen to start doing reviews for all PRs here from now on. This one has a bit of technical stuff with the documentation CI, but it would be good to have you and virgile accross this stuff in future anyway, it's not really very complicated.

Besides new github workflows to make these docs actually build, and deleting old things, mostly this restructures the docs so they are easier to read and use to define rules, but it would be good to get a second opinion on if it achieves that.

@rafaqz
Copy link
Member Author

rafaqz commented Jan 28, 2021

@jamesmaino can you have a quick look and approve, just to get this review ball rolling. This as no consequence on models its just docs so its low pressure ;).

I've got some more updates to come after this that will be easier once this is merged.

@rafaqz rafaqz merged commit 999be5e into master Jan 28, 2021
@rafaqz rafaqz deleted the rule_docs branch January 28, 2021 23:54
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