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

copyright comments use /* only #2268

Merged
merged 2 commits into from
Mar 19, 2018
Merged

copyright comments use /* only #2268

merged 2 commits into from
Mar 19, 2018

Conversation

giladgray
Copy link
Contributor

@giladgray giladgray commented Mar 19, 2018

part of #2266

fixes some issues where entities would have the copyright statement as their documentation.

why?

/** is a JSDoc comment, meaning it contains useful user-facing documentation. Tools like VS Code and Typedoc will pick up /** comments and display them in tooltips etc.

/* is a simple block comment, meaning it contains a comment about some code and can span multiple lines.

⇒ These copyright blocks should be block comments as they are not documentation.

@giladgray giladgray requested a review from llorca March 19, 2018 17:46
@blueprint-bot
Copy link

more comments

Preview: documentation | landing | table

Copy link
Contributor

@llorca llorca left a comment

Choose a reason for hiding this comment

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

LGTM. OOC, why /* instead of /**?

@giladgray
Copy link
Contributor Author

@llorca updated description with answer

@@ -8,6 +8,8 @@ $banner-height: $pt-grid-size * 4;

// banner along top of screen linking to v2 docs
.docs-banner {
flex: 0 0 auto;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

oh this should fix the banner issue

@giladgray giladgray merged commit 4fd3b46 into develop Mar 19, 2018
@giladgray giladgray deleted the gg/docs-comments branch March 19, 2018 20:51
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.

4 participants