Doc cleanups#267
Merged
Merged
Conversation
Joseph-Edwards
approved these changes
Jun 13, 2025
Joseph-Edwards
left a comment
Joseph-Edwards
left a comment
Collaborator
There was a problem hiding this comment.
Thanks @james-d-mitchell. There are a few things that this PR highlighted, but I will fix those in separate PRs.
Comment on lines
+335
to
+349
| m.def( | ||
| "knuth_bendix_redundant_rule", | ||
| [](Presentation<std::string> const& p, std::chrono::milliseconds t) | ||
| -> std::optional<std::pair<std::string, std::string>> { | ||
| auto it = knuth_bendix::redundant_rule(p, t); | ||
| if (it != p.rules.cend()) { | ||
| return std::make_pair(*it, *(it + 1)); | ||
| } | ||
| return {}; | ||
| }, | ||
| // Signature required to avoid generating any doc | ||
| R"pbdoc( | ||
| :sig=(p: Presentation, t: datetime.timedelta) -> tuple[list[int], list[int]] | tuple[str, str] | None: | ||
| :only-document-once: | ||
| )pbdoc"); |
Collaborator
There was a problem hiding this comment.
This fixes the doc, but this function probably shouldn't be bound in bind_knuth_bendix, since redundant_rule doesn't depend on the template arguments. Hence, we end up binding the functions 8 times, rather than twice. I will fix this in a separate PR.
| should be performed.)pbdoc") | ||
| .value( | ||
| "hlt", | ||
| // JDM couldn't get the links to work in the following doc string. |
Collaborator
There was a problem hiding this comment.
I think if the enums were written like tril, we could get this to work. I'll give it a go, and open a new PR if it works. Otherwise, I think this is fine.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.