Conversation
There was a problem hiding this comment.
@emmurphy1 I've approved, but just pointing out that my understanding is that although the abstract tag indeed isn't required by tooling, which will pull the first paragraph as the abstract, it's a failsafe to ensure an abstract is pulled in the event that a writer doesn't include spacing between the header and the first paragraph. I believe both pv2 and Jupiter rely on the line break following the header and following the first paragraph are the delimiters for the abstract. Should anyone or anything (auto-generated content) disregard the line break(s), then the abstract tag would be the failsafe in that case. I could be wrong, but in case this comes up after we make this change, I wanted us to be aware.
I do agree though to ditch the tag regardless for the sake of vast majority of successful cases.
…e and assembly or module introduction
|
|
||
| //// | ||
| The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide | ||
| The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide. |
There was a problem hiding this comment.
I would consider replacing the "guide" term with something already-defined or unequivocal - assembly of assemblies, an assembly that includes other assemblies, ...
There was a problem hiding this comment.
We discussed this in today's meeting and we will consider this after we start using Jupiter.
|
LGTM. |
No description provided.