-
Notifications
You must be signed in to change notification settings - Fork 132
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.
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
Remove empty title
tags in generated tests
#2186
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @lhw-1, thank you for the work on this!
I agree with the point that you raised that maybe using the title of the file would be a better way to generate the default title. Default is urm.. not the best 😂
title
tagstitle
tags in generated tests
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
What is the purpose of this pull request?
Overview of changes:
Resolves #2166.
As pointed out in the issue thread, instead of removing thetitle
tag altogether when empty, it would be a better practice to simply declare a default title for sites, e.g. "Default", as is currently being done for thelayout
property (with the default value declared here). This PR consists of a straightforward fix by implementing a default value for thetitle
tag.As per the discussion in the original issue, after comparing approaches taken by other static site generators, we decided to stick with the default behavior, and additionally address the original concern of removing any unnecessary empty
title
tags generated (as well as prevent any emptytitle
tags from being generated in the future).Anything you'd like to highlight/discuss:
The default value is currently set to "Default", but suggestions on a better title are needed.(Setting thetitle
as the name of the.md
file could be a better idea)Once the fix has been finalized, documentation (primarily the user guide) will be updated as well.Testing instructions:
Proposed commit message: (wrap lines at 72 characters)
Remove empty
title
tags in generated testsChecklist: ☑️