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

Jump to bottom

Update rdoc_markup.rb #1318

Merged
merged 1 commit into from
May 3, 2020
Merged

Update rdoc_markup.rb #1318

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
9 changes: 5 additions & 4 deletions lib/yard/templates/helpers/markup/rdoc_markup.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,17 @@ class RDocMarkupToHtml < SM::ToHtml; end
class RDocMarkup
attr_accessor :from_path

@@mutex = Mutex.new
@@formatter = nil
@@markup = nil
@@mutex = nil

def initialize(text)
@text = text

@@formatter ||= RDocMarkupToHtml.new
@@markup ||= MARKUP.new
@@mutex ||= Mutex.new
@@mutex.synchronize do
@@formatter ||= RDocMarkupToHtml.new
@@markup ||= MARKUP.new
Copy link

Choose a reason for hiding this comment

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

Why are these lazy to begin with?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good question!

Copy link
Owner

@lsegal lsegal Mar 27, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

@headius to minimize memory overhead when the classes might be autoloaded but not necessarily used. Since RDocMarkupToHtml is not owned by YARD (more precisely, the class it inherits is not owned by YARD), there's no reliable way to control how much memory is being wired up when it's initialized.

That said, the case where this file is autoloaded but not used is on the unlikely side, so if there are good reasons to change it, I'm not opposed. I don't see a problem with the change as-is, though.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is it so slow that making one instance per class is out of the question?

Copy link
Owner

Choose a reason for hiding this comment

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

Sorry for the late reply @ioquatix: I'm not sure, but these things are instantiated quite often so I would guess the answer is yes. If you want to benchmark to check it out, feel free!

end
end

def to_html
Expand Down