NFC: Improved documentation of crmPageTitle directive. #13337
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Documented assumption that AngularJS base page be named "CiviCRM".
Comments
Is there interest in removing this requirement? It seems like the values for
pageTitle
anddocumentTitle
could be derived in thelink
function and assigned to local variables instead of being hardcoded to global variables. My gut, however, tells me that perhaps the code was written this way for a reason (i.e., mysterious bugs).It is a little unusual that
update
is wrapped in a$timeout
. If I had to guess, it's to keep the$watch
function from triggering unnecessarily, sinceupdate
changes both parts of the watched expression. Does this effectively make the change atomic, rather than having the$watch
function fire once whenpageTitle
is updated and again whendocumentTitle
is updated?