Add doc block for IQuery.projection#3919
Conversation
IProjection is the only location which is currently using the JSON-like serialization of Perms and Units. It seems useful then to place the documentation for these directly on the method. See: https://trello.com/c/vdyTStEq/40-unit-documentation
|
The text looks good and documentation is to be encouraged. 👍 One niggle is that I don't see the nice formatting in |
|
Pushed. Open to suggestions; this is readable in the HTML now, but less so in the .ice. :/ |
|
Looks good in the HTML indeed; this PR is good to merge. If you prefer, could revert back to something more like your original, with: add "(a)", "(b)", bullets, punctuation to turn that first |
|
Got thumbs up from @hflynn. No strong feeling from my side on the formatting policy. Merging. We can always unify later. |
Add doc block for IQuery.projection
IProjection is the only location which is currently
using the JSON-like serialization of Perms and Units.
It seems useful then to place the documentation for
these directly on the method.
See: https://trello.com/c/vdyTStEq/40-unit-documentation