Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow user to override the comment in the generated file #27

Merged
merged 1 commit into from
Jul 11, 2020

Conversation

alexeagle
Copy link
Contributor

Useful if they have some specific instructions to put there about how to update it

@alexeagle alexeagle requested a review from zegl as a code owner June 10, 2020 13:20
alexeagle pushed a commit to alexeagle/rules_nodejs that referenced this pull request Jun 10, 2020
alexeagle pushed a commit to alexeagle/rules_nodejs that referenced this pull request Jun 10, 2020
@zegl
Copy link
Owner

zegl commented Jun 10, 2020

Hey Alex! Great change!

It looks like stardoc doesn't appreciate multiline default values 😕. I did some testing and it seems like wrapping $attribute.defaultValue in a call to $util.markdownCellFormat() will do the trick.

I'm OK with having a custom stardoc rule_template in this project if we need to, but it would be even better if we could get it upstreamed. :-)

@zegl
Copy link
Owner

zegl commented Jun 10, 2020

Your change to remove the newline also makes sense, and might be even better.

Useful if they have some specific instructions to put there about how to update it
@alexeagle
Copy link
Contributor Author

Yeah I had to vendor the stardoc templates in rules_nodejs to fix a bunch of stuff :/
Doesn't seem like it's worth fighting with it? I hate to change the behavior of the rule just to make it user-controlled.

alexeagle pushed a commit to bazel-contrib/rules_nodejs that referenced this pull request Jun 11, 2020
@alexeagle
Copy link
Contributor Author

ping!

Copy link
Owner

@zegl zegl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the ping.

Yeah, it's annoying to have to remove the newline, but it's worth it IMO.

I'll get this change in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants