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

Already on GitHub? Sign in to your account

Avoid generating documentation pages for internal components #1047

Merged
merged 1 commit into from
Dec 13, 2024
+9 −11
Merged

Avoid generating documentation pages for internal components #1047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion .document
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
LICENSE.txt
README.md
EXTEND_IRB.md
COMPARED_WITH_PRY.md
doc/irb/indexes.md
lib/**/*.rb
lib/irb.rb
lib/irb/context.rb
lib/irb/command/base.rb
2 changes: 0 additions & 2 deletions Rakefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,6 @@ task :default => :test

RDoc::Task.new do |rdoc|
rdoc.title = "IRB"
rdoc.rdoc_files.include("*.md", "lib/**/*.rb")
rdoc.rdoc_files.exclude("lib/irb/xmp.rb")
Copy link
Member Author

Choose a reason for hiding this comment

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

If we use these options, .document will be ignored. Since .document will be applied to ruby/ruby's documentation generation too, we should prioritize using it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Actually, this is not correct. I think it'd be better if that's the case though. Will see how I can make it happen.

Copy link
Member Author

Choose a reason for hiding this comment

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

@tompng I opened ruby/ruby#12325 for this. Can you review it there too?

rdoc.rdoc_dir = "docs"
rdoc.main = "README.md"
rdoc.options.push("--copy-files", "LICENSE.txt")
Expand Down
2 changes: 1 addition & 1 deletion lib/irb.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -879,7 +879,7 @@
module IRB

# An exception raised by IRB.irb_abort
class Abort < Exception;end
class Abort < Exception;end # :nodoc:

class << self
# The current IRB::Context of the session, see IRB.conf
Expand Down
10 changes: 3 additions & 7 deletions lib/irb/command/base.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@
#

module IRB
# :stopdoc:

module Command
class CommandArgumentError < StandardError; end
class CommandArgumentError < StandardError; end # :nodoc:

class << self
def extract_ruby_args(*args, **kwargs)
def extract_ruby_args(*args, **kwargs) # :nodoc:
throw :EXTRACT_RUBY_ARGS, [args, kwargs]
end
end
Expand Down Expand Up @@ -57,8 +55,6 @@ def execute(arg)
end
end

Nop = Base
Nop = Base # :nodoc:
end

# :startdoc:
end
Loading