* Copy editing for clarity in several locations
* Rename "Titles" section to "Headings"
* Fix incorrect anchor in link to API Documentation Guidelines for filenames
The template runs before the generation of binstubs – this does not
allow to write one, that makes an initial commit to version control.
It is solvable by adding an after_bundle callback.
Email does not support relative links since there is no implicit host. Therefore all links inside of emails must be fully qualified URLs. All path helpers are now deprecated. When removed, the error will give early indication to developers to use `*_url` methods instead.
Currently if a developer uses a `*_path` helper, their tests and `mail_view` will not catch the mistake. The only way to see the error is by sending emails in production. Preventing sending out emails with non-working path's is the desired end goal of this PR.
Currently path helpers are mixed-in to controllers (the ActionMailer::Base acts as a controller). All `*_url` and `*_path` helpers are made available through the same module. This PR separates this behavior into two modules so we can extend the `*_path` methods to add a Deprecation to them. Once deprecated we can use this same area to raise a NoMethodError and add an informative message directing the developer to use `*_url` instead.
The module with warnings is only mixed in when a controller returns false from the newly added `supports_relative_path?`.
Paired @sgrif & @schneems
Even if this is not exactly the same, let's add a new-line character
instead of two spaces. While it's specified in the Markdown specs that
adding spaces at the end of the line creates a break-line tag, this is
a brittle approach as people may remove them saving the file on certain
editors.
These methods may cause confusion with the `reset_changes` that
behaves differently
of them.
Also rename undo_changes to restore_changes to match this new set of
methods.
* Leave two blank lines between sections/packages for readibility.
* Always indent bullet points with four spaces. This allows multi-paragraph
points to align properly (see #16103), and it is the same as the format we
already use in CHANGELOGs. Doing this consistently sets an easy precedent
for future contributors to follow.
* Always put the PR/commit link on its own line in the source. If the bullet
point spans multiple paragraphs, put it on its own paragraph at the end.
[Godfrey Chan & Juanito Fatas]
This reverts commit 0f6b101e09d210cea2494c5d4225760f1951ea67.
Reason: It's better to let `unscope` be documented. We can add a
separate section for `except`.
