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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation for new timeout functionality #708

Merged
merged 1 commit into from Apr 26, 2024
Merged

Update documentation for new timeout functionality #708

merged 1 commit into from Apr 26, 2024

Conversation

jcouball
Copy link
Member

Your checklist for this pull request

馃毃Please review the guidelines for contributing to this repository.

  • Ensure all commits include DCO sign-off.
  • Ensure that your contributions pass unit testing.
  • Ensure that your contributions contain documentation if applicable.

Description

Updates are to documentation only. No code was changed.

  • More precisely described when timeouts can be specified and what impact they have: the git command is killed and a Git::TimeoutError is raised.
  • Describe the global timeout vs. method timeouts
  • Update bin/command_line_test to be able to sleep for a specific number of seconds to test timeouts.
  • Update YARD doc to indicate that the timeout value is a Numeric or nil.
  • Update Git.clone YARD doc

@jcouball
Update documentation for new timeout functionality
84c9348 
Signed-off-by: James Couball <jcouball@yahoo.com>
@jcouball jcouball merged commit 7e99b17 into master Apr 26, 2024
8 checks passed
@jcouball jcouball deleted the doc_timeout branch April 26, 2024 00:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@jcouball