Clarify how-to docs for new units #509
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.
Some users have found some aspects of these docs confusing. This PR
fixes them up to make the guide easier to use. Here are the problems
and how we handled them.
Problem: It was unclear which namespace should contain the
definitions of new units.
, in your project's namespaceto thecomments in the guide.
Problem: It was unclear which namespace the
symbolsnamespaceshould go in.
as well.
Problem: The
au::namespace was omitted from Au libraryconstructs, making it unclear whether we had elided a
usingclause,or whether we wanted users to define the units in the
aunamespace.We had been writing the docs by omitting the
aunamespace toreduce visual clutter, but this is less appropriate for a how-to
guide. We have added the namespace.
Of course, this last point applies with equal force to every other
how-to guide. It's OK to eliminate the
au::namespace qualifier inthe text, but we should keep the code samples as usable as possible.
Therefore, we apply this approach more consistently.
Fixes #504.