-
Notifications
You must be signed in to change notification settings - Fork 17
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
[DOC-81] Update "Managing Timeouts" Section #159
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some comments/suggestions :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is excellent work, I'm very excited that we're adding it.
I think my main high-level comment is that the guide could be more directive. I expect that the primary use case for the guide is someone has a timeout and wants to know what to do next. So I think more information in the diagnosis sections about how to concretely tell which kind of timeout you have, with forward links to the sections that describe how to resolve them.
Similarly, there's several places where we say "you can summarize ..." but we haven't really explained what that is or how to do it. I think that information probably belongs on its own page somewhere in this section. Writing it is maybe beyond the scope of this PR, but maybe putting in a placeholder with a paragraph or two would be good.
I think this section would really benefit from examples, but I know constructing timeout examples is hard. Maybe you could work with Sitvanit, who is putting together examples for other CVL features.
Co-authored-by: Michael D. George <[email protected]>
Co-authored-by: Michael D. George <[email protected]>
Points taken -- I think they all make sense, I plan to work on this page more in the future, and will try to drive things in that direction. (For this PR I hope that it can establish some basic concepts that the more practical instructions can build on .. and have some first shot at practical items ..) |
Heads-up: |
I think we discussed everything, to a sufficient extent -- and I'd like to land this :-) ... -- I can change always things in another PR of course
Towards a new and revised "Managing Timeouts" section.
Notes:
Jira ticket: https://certora.atlassian.net/browse/DOC-345
Link to generated documentation: https://certora-certora-prover-documentation--159.com.readthedocs.build/en/159/docs/user-guide/timeouts/index.html