Skip to content

[DOC] Missing documents #45

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nobu merged 2 commits into from
Dec 20, 2023
Merged

[DOC] Missing documents #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b41f33d
[DOC] Exclude non-documented files
nobu Dec 18, 2023
301ad4c
[DOC] Missing documents
nobu Dec 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .document
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
LICENSE.txt
README.md
lib/
Copy link
Member

@eregon eregon Dec 18, 2023

Choose a reason for hiding this comment

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

Does it make sense to include lib/ here?
I couldn't find any docs about a .document file for RDoc.

Copy link
Member Author

@nobu nobu Dec 20, 2023

Choose a reason for hiding this comment

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

lib/timeout.rb itself.
If no .document file, all files under the directory will be read.

5 changes: 3 additions & 2 deletions lib/timeout.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,19 @@
# Copyright:: (C) 2000 Information-technology Promotion Agency, Japan

module Timeout
# The version
VERSION = "0.4.1"

# Internal error raised to when a timeout is triggered.
class ExitException < Exception
def exception(*)
def exception(*) # :nodoc:
self
end
end

# Raised by Timeout.timeout when the block times out.
class Error < RuntimeError
def self.handle_timeout(message)
def self.handle_timeout(message) # :nodoc:
exc = ExitException.new(message)

begin
Expand Down