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 docs #356

Merged
merged 13 commits into from
Oct 9, 2024
Merged

Improve docs #356

merged 13 commits into from
Oct 9, 2024

Conversation

YehorBoiar
Copy link
Contributor

@YehorBoiar YehorBoiar commented Oct 4, 2024

Improving documentation. Ideally, I would like to see all methods and methods` parametres in rule_engine documented.

TODO for rewrite.rs:

  • Add examples in documentation (note: where examples haven't been found - we have "// add an example" comment for better navigation)
  • Add docstring for choose_rewrite
  • Add docstring for apply_all_rules
  • Imrpove docstring for Expression
  • Add docstrings for Model struct
  • Add docstrings for RewriterStats
  • Improve docstring for RuleSet
  • Add docstrings for RewriteError
  • Make tests pass

@YehorBoiar
Copy link
Contributor Author

@Soph1514 Would you like to help with this PR? It could be a great collaboration practice before we start working on rule engine!

@YehorBoiar YehorBoiar self-assigned this Oct 4, 2024
@YehorBoiar YehorBoiar changed the title Added docstring to rule engine Improve docs Oct 4, 2024
@@ -143,7 +261,7 @@ fn apply_all_rules<'a>(
) -> Vec<RuleResult<'a>> {
let mut results = Vec::new();
for rule in rules {
match rule.apply(expression, model) {
Copy link
Contributor Author

@YehorBoiar YehorBoiar Oct 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accidentally changed this line

@YehorBoiar
Copy link
Contributor Author

YehorBoiar commented Oct 6, 2024

Commented out the docstring examples as they were causing the cargo test --workspace command to fail in the CI pipeline. The examples were meant to provide additional context for abstract functions but aren't critical to the descriptions. Open to feedback on whether to rework these examples to pass the tests or move them to a separate file for better context without affecting the CI process. @ozgurakgun

@YehorBoiar YehorBoiar marked this pull request as ready for review October 8, 2024 14:42
@ozgurakgun ozgurakgun merged commit 0416c33 into conjure-cp:main Oct 9, 2024
8 checks passed
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.

3 participants