Skip to content

Add more log statements to site_github_munger. #189

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add more log statements to site_github_munger. #189

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
11f2674
Add more log statements to site_github_munger.
NullableInt Jul 2, 2020
f367903
Update site_github_munger.rb
NullableInt May 31, 2021
f5e9a9c
Update lib/jekyll-github-metadata/site_github_munger.rb
NullableInt May 31, 2021
7d1f5db
Update site_github_munger.rb
NullableInt Jun 1, 2021
911272e
Merge branch 'master' into patch-1
NullableInt Jun 1, 2021
5185893
Update lib/jekyll-github-metadata/site_github_munger.rb
NullableInt Jun 1, 2021
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
5 changes: 4 additions & 1 deletion lib/jekyll-github-metadata/site_github_munger.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,13 @@ def drop

# Set `site.url` and `site.baseurl` if unset.
def add_url_and_baseurl_fallbacks!
site.config["url"] ||= Value.new("url", proc { |_c, r| r.url_without_path })
Jekyll::GitHubMetadata.log :debug, "Adding URL and base URL fallbacks..."
Copy link
Contributor

@MichaelCurrin MichaelCurrin May 31, 2021

Choose a reason for hiding this comment

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

This describes the whole function, so some whitespace is useful, so indicate it applies to the section and not just the line or two directly after it.

Suggested change
Jekyll::GitHubMetadata.log :debug, "Adding URL and base URL fallbacks..."
Jekyll::GitHubMetadata.log :debug, "Adding URL and base URL fallbacks..."

site.config["url"] ||= Value.new("url", proc { |_c, r| r.url_without_path })
Jekyll::GitHubMetadata.log :debug, "URL is set to #{site.config["url"]}"
return unless should_set_baseurl?

site.config["baseurl"] = Value.new("baseurl", proc { |_c, r| r.baseurl })
Jekyll::GitHubMetadata.log :debug, "baseurl is set to #{site.config["baseurl"]}"
Copy link
Contributor

@MichaelCurrin MichaelCurrin May 31, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Use base URL here for consistency with the above.

Or use url and baseurl (lowercase, no spaces) throughout. With backticks or single quotes would be nice.

e.g.

"Adding `url` and `baseurl` fallbacks..."

and

"`baseurl` is set to #{site.config["baseurl"]}"

end

def add_title_and_description_fallbacks!
Expand Down