Add get_documentation() to EnumMessage. #206
Conversation
|
Thanks for the PR. Just a couple of minor tweaks I think. I'm a little worried that people will mis-use this feature, and negatively impact the quaility of their own documentation, but I also see the practical benefit of something like this so I think it's okay. |
|
What are the minor tweaks you'd like to see? |
| let params = params.clone(); | ||
| // Push the documentation. | ||
| documentation_arms | ||
| .push(quote! { &#name::#ident #params => ::core::option::Option::Some(concat!(#( #documentation ),*).trim()) }); |
There was a problem hiding this comment.
Thoughts on concatenating vs using newlines? Obviously this won't be a full markdown parser, but I'm wondering if just concatenating lines is too simple.
There was a problem hiding this comment.
To make this friendlier to markup, I remove the leading space from each line, and only if there are multiple lines, I suffix each one with a new line when I concatenate them. This way a single-line comment becomes a simple string (w/o a final newline) but a multi-line comment preserves the indentation structure and the final newline in each line.
strum_tests/tests/enum_message.rs
Outdated
| Bird, | ||
| /// I'm disabled. |
There was a problem hiding this comment.
May as well make the comment overly explicit since it's just a test case.
/// get_documentation() will return None because #[strum(disabled)] is present
|
I forgot to hit submit review :( sorry about that |
|
Did a pass (trying) to address the review issues. |
|
Ok, checks pass now. |
|
Released as part of |
Implement #203.