Improve the MatrixFree doxygen formatting #7167
Conversation
include/deal.II/grid/tria_iterator.h
Outdated
| * DoFAccessor, respectively. Each group also has specialized accessors for | ||
| * cells (as opposed to faces and lines) that offer more functionality such as | ||
| * accessing neighbors. | ||
| * DoFHandler - hp::DoFHandler objects. They are derived from |
There was a problem hiding this comment.
That looks uncommon. Why do you want to use - instead of /?
There was a problem hiding this comment.
I thought the opposite: hyphens are for linking words together in prose. I don't think I have seen /s used to do that.
There was a problem hiding this comment.
But you're not connecting; you're enumerating. I think "/" is correct here.
(You'd use the dash in a sentence like "While the Vector-Matrix connection is clear, the Triangulation-DoFHandler connection is harder to understand.")
There was a problem hiding this comment.
I should get a style manual and read it. Wikipedia says that / can be used as a shorthand for 'and' so lets stick with / here; you're right.
drwells
force-pushed
the
step-37-spinoffs
branch
from
ec529c9
to
1864b8d
Compare
|
I fixed the |
include/deal.II/grid/tria_iterator.h
Outdated
| @@ -165,10 +165,10 @@ class TriaActiveIterator; | |||
| * | |||
| * The accessors provided by the library consists of two groups, determined by | |||
There was a problem hiding this comment.
while you're here, can you replace "consists" by "consist" to get the grammar right? Though maybe "fall" or "can be grouped into two classes" would actually be better
drwells
force-pushed
the
step-37-spinoffs
branch
from
1864b8d
to
8937fe1
Compare
This is a followup to #7129: I added name qualifications and a few other minor things to make it easier to read the matrix free module header.