Add docs for Vector, Point and Matrix types #35
Conversation
kvark
left a comment
kvark
left a comment
There was a problem hiding this comment.
Thank you for the PR!
No major concerns, just a few questions.
src/matrix.rs
Outdated
| $( #[doc = $doc:expr] )* | ||
| $name:ident: $major_ty:ident $vec:ident[ $($field:ident = $index:expr),* ] = ($inner:expr, $outer:expr) | ||
| ) => { | ||
| decl_matrix_type! { |
There was a problem hiding this comment.
is there a point for a separate macro here if it's not used elsewhere?
There was a problem hiding this comment.
So, documentation generation for types declared in macros requires you to use the doc attribute, which is quite unwieldy.
The attribute itself can only take either a string literal, or a $expr fragment as its single argument, which means that:
- you either have to construct the doc comment line by line using a sequence of
#[doc = "blah"]#[doc = $string_expr]statements for interpolation, or: - you can do the interpolation using
concat!andstringify!, and then pass that off to another macro (example taken from here), à la a c-style stringification macro.
I wish it were easier as well, but I think this is the simplest way I could find.
src/vector.rs
Outdated
| #[doc = "Constructs a `"] | ||
| #[doc = $sname] | ||
| #[doc = "` from the first "] | ||
| #[doc = $dim] |
There was a problem hiding this comment.
wow that's quite strange. Is there a way to do string interpolation here?
src/vector.rs
Outdated
| $(#[doc = $doc:expr])* | ||
| $name:ident ($dim:expr) [ $($field:ident = $index:expr),* ] = $fixed:ty | ||
| ) => { | ||
| decl_vector_type! { |
There was a problem hiding this comment.
same question here - why do we need a separate macro?
|
Can you please rebase on top of master instead of going with the merge commit? |
2 participants
Happy to bikeshed exactly what the docs should say