fix(docs-infra): make API member name bold #31574

sjtrimble · 2019-07-15T21:13:20Z

~~Remove linenums on API interface overview code block~~ Addressed in a different PR.
Return API member name bold font weight
SCSS formatting cleanup

Closes #31494

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

Bugfix
Feature
Code style update (formatting, local variables)
Refactoring (no functional changes, no api changes)
Build related changes
CI related changes
Documentation content changes
angular.io application / infrastructure changes
Other... Please describe:

What is the current behavior?

#31494

Issue Number: #31494

Does this PR introduce a breaking change?

Yes
No

mary-poppins · 2019-07-15T21:19:40Z

You can preview c938e43 at https://pr31574-c938e43.ngbuilds.io/.

mary-poppins · 2019-07-15T21:21:04Z

You can preview 99df6be at https://pr31574-99df6be.ngbuilds.io/.

aio/src/styles/2-modules/_api-list.scss

aio/tools/transforms/templates/api/includes/interface-overview.html

aio/src/styles/2-modules/_api-pages.scss

mary-poppins · 2019-07-19T17:11:38Z

You can preview 7ad9a62 at https://pr31574-7ad9a62.ngbuilds.io/.

mary-poppins · 2019-08-02T19:58:36Z

You can preview 169a80d at https://pr31574-169a80d.ngbuilds.io/.

gkalpak

One minor nit, plus that the last fixup commit (d6b76d1) does not match the original commit. It's header is fixup! fix(docs-infra): return deprecated styles for api list instead of fixup! fix(docs-infra): remove lineums on api interface overview.

@sjtrimble, once you've made the fixes, feel free to remove the cleanup label and add the merge label 😉

gkalpak · 2019-08-06T15:13:00Z

aio/src/styles/2-modules/_api-list.scss

@@ -205,7 +205,7 @@ aio-api-list {
        color: $blue-500;
      }

-      &.deprecated-api-item {
+       &.deprecated-api-item {


Incorrect indentation 😁

mary-poppins · 2020-03-06T12:32:06Z

You can preview dd5e430 at https://pr31574-dd5e430.ngbuilds.io/.

- Return API member name bold font weight - SCSS formatting cleanup Closes angular#31494

mary-poppins · 2020-03-06T12:49:24Z

You can preview 0491bf1 at https://pr31574-0491bf1.ngbuilds.io/.

This commit merges the two `.api-body` style blocks, removing duplicate styles and re-ordering sub-blocks (to group relevant styles together). It should not affect styling.

gkalpak · 2020-03-06T12:55:48Z

@googlebot I consent.

googlebot · 2020-03-06T12:55:54Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

gkalpak · 2020-03-06T12:56:46Z

aio/src/styles/2-modules/_api-pages.scss

@@ -294,18 +294,6 @@
  }
 }

-.github-links {


There is a practically identical block further up this file.

gkalpak · 2020-03-06T13:01:17Z

Thx for the ping, @ajitsinghkaler 👍

I went ahead and cleaned it up myself, because you wouldn't have enough permissions to update the PR. While doing so, I realized that the linenums for interface overview had already been removed in an earlier PR, so this PR was mainly making API member name bold (and cleaning up SCSS code). I updated the commit messages to reflect that.

I also noticed that the _api-pages.scss code needed further clean-up (remove duplicate style and merge style-blocks). So, I pushed another two commits to address that. (My two commits should not have any impact on styling - just refactoring.)

@sjtrimble, @ajitsinghkaler: Please take a look at the changes/preview to make sure I didn't accidentally mess something up 🙏

mary-poppins · 2020-03-06T13:04:02Z

You can preview af4aec9 at https://pr31574-af4aec9.ngbuilds.io/.

ajitsinghkaler

Type-alias api type highlighting is still left

@gkalpak most of it looks good just one question we have highlighted interface's classes elements

When I was checking out I saw type alias elements are not being highlighted any specific reason for that I think its best we highlight them too for consistency I 've attached screenshots for your reference.

Rest LGTM.

gkalpak · 2020-03-11T12:51:16Z

Thx for taking a look, @ajitsinghkaler! I don't think we can fix this, because there doesn't seem to be a way to target type-alias members atm. For interfaces, they are identified as members and we can attach the member-name class to them, but type-aliases we don't have such granular tokenization.

I am not sure whether this is a limitation of TypeScript or whether it is something that can be fixed in dgeni, but in any case I believe this is outside of the scope of this PR.

Based on your feedback, I am marking this for merging and we can address any additional concerns/improvements in follow-up PRs.

PR Close #31574

This commit merges the two `.api-body` style blocks, removing duplicate styles and re-ordering sub-blocks (to group relevant styles together). It should not affect styling. PR Close #31574

- Return API member name bold font weight - SCSS formatting cleanup Closes #31494 PR Close #31574

PR Close #31574

This commit merges the two `.api-body` style blocks, removing duplicate styles and re-ordering sub-blocks (to group relevant styles together). It should not affect styling. PR Close #31574

angular-automatic-lock-bot · 2020-04-11T16:06:45Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

sjtrimble added action: review The PR is still awaiting reviews from at least one requested reviewer comp: docs-infra labels Jul 15, 2019

sjtrimble requested review from petebacondarwin and gkalpak July 15, 2019 21:13

sjtrimble requested a review from a team as a code owner July 15, 2019 21:13

sjtrimble self-assigned this Jul 15, 2019

ngbot bot added this to the needsTriage milestone Jul 15, 2019

googlebot added the cla: yes label Jul 15, 2019

sjtrimble force-pushed the soften-api-lineums branch from c938e43 to 99df6be Compare July 15, 2019 21:14

gkalpak added state: WIP target: patch This PR is targeted for the next patch release and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Jul 16, 2019

gkalpak reviewed Jul 16, 2019

View reviewed changes

sjtrimble force-pushed the soften-api-lineums branch from 99df6be to 7ad9a62 Compare July 19, 2019 17:02

sjtrimble added the action: review The PR is still awaiting reviews from at least one requested reviewer label Jul 19, 2019

gkalpak removed the action: review The PR is still awaiting reviews from at least one requested reviewer label Jul 20, 2019

sjtrimble force-pushed the soften-api-lineums branch from 7ad9a62 to 169a80d Compare August 2, 2019 19:52

sjtrimble added the action: review The PR is still awaiting reviews from at least one requested reviewer label Aug 2, 2019

gkalpak removed the action: review The PR is still awaiting reviews from at least one requested reviewer label Aug 3, 2019

gkalpak added this to IN PROGRESS in docs-infra Aug 3, 2019

gkalpak approved these changes Aug 6, 2019

View reviewed changes

gkalpak added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews and removed state: WIP labels Aug 6, 2019

gkalpak removed the request for review from petebacondarwin August 6, 2019 15:16

sjtrimble force-pushed the soften-api-lineums branch from d6b76d1 to 698999a Compare August 6, 2019 23:36

sjtrimble and others added 2 commits March 6, 2020 14:39

fix(docs-infra): make API member name bold

bfe71e5

- Return API member name bold font weight - SCSS formatting cleanup Closes angular#31494

fixup! fix(docs-infra): make API member name bold

0491bf1

gkalpak force-pushed the soften-api-lineums branch from dd5e430 to 0491bf1 Compare March 6, 2020 12:41

gkalpak changed the title ~~fix(docs-infra): remove linenums on API interface overview~~ fix(docs-infra): make API member name bold Mar 6, 2020

refactor(docs-infra): remove duplicate .github-links styles

cefef76

refactor(docs-infra): merge .api-body style blocks

af4aec9

This commit merges the two `.api-body` style blocks, removing duplicate styles and re-ordering sub-blocks (to group relevant styles together). It should not affect styling.

googlebot added cla: yes and removed cla: no labels Mar 6, 2020

gkalpak reviewed Mar 6, 2020

View reviewed changes

gkalpak added action: review The PR is still awaiting reviews from at least one requested reviewer type: bug/fix and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Mar 6, 2020

ajitsinghkaler reviewed Mar 7, 2020

View reviewed changes

gkalpak added action: merge The PR is ready for merge by the caretaker and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Mar 11, 2020

matsko closed this in cffbaba Mar 11, 2020

matsko pushed a commit that referenced this pull request Mar 11, 2020

refactor(docs-infra): remove duplicate .github-links styles (#31574)

7bd5368

PR Close #31574

matsko pushed a commit that referenced this pull request Mar 11, 2020

fix(docs-infra): make API member name bold (#31574)

7b0a1d2

- Return API member name bold font weight - SCSS formatting cleanup Closes #31494 PR Close #31574

matsko pushed a commit that referenced this pull request Mar 11, 2020

refactor(docs-infra): remove duplicate .github-links styles (#31574)

2ff4d11

PR Close #31574

angular-automatic-lock-bot bot locked and limited conversation to collaborators Apr 11, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(docs-infra): make API member name bold #31574

fix(docs-infra): make API member name bold #31574

sjtrimble commented Jul 15, 2019 •

edited by gkalpak

mary-poppins commented Jul 15, 2019

mary-poppins commented Jul 15, 2019

mary-poppins commented Jul 19, 2019

mary-poppins commented Aug 2, 2019

gkalpak left a comment •

edited

gkalpak Aug 6, 2019

mary-poppins commented Mar 6, 2020

mary-poppins commented Mar 6, 2020

gkalpak commented Mar 6, 2020

googlebot commented Mar 6, 2020

gkalpak Mar 6, 2020

gkalpak commented Mar 6, 2020

mary-poppins commented Mar 6, 2020

ajitsinghkaler left a comment •

edited

gkalpak commented Mar 11, 2020

angular-automatic-lock-bot bot commented Apr 11, 2020

fix(docs-infra): make API member name bold #31574

fix(docs-infra): make API member name bold #31574

Conversation

sjtrimble commented Jul 15, 2019 • edited by gkalpak

PR Checklist

PR Type

What is the current behavior?

Does this PR introduce a breaking change?

mary-poppins commented Jul 15, 2019

mary-poppins commented Jul 15, 2019

mary-poppins commented Jul 19, 2019

mary-poppins commented Aug 2, 2019

gkalpak left a comment • edited

Choose a reason for hiding this comment

gkalpak Aug 6, 2019

Choose a reason for hiding this comment

mary-poppins commented Mar 6, 2020

mary-poppins commented Mar 6, 2020

gkalpak commented Mar 6, 2020

googlebot commented Mar 6, 2020

gkalpak Mar 6, 2020

Choose a reason for hiding this comment

gkalpak commented Mar 6, 2020

mary-poppins commented Mar 6, 2020

ajitsinghkaler left a comment • edited

Choose a reason for hiding this comment

gkalpak commented Mar 11, 2020

angular-automatic-lock-bot bot commented Apr 11, 2020

sjtrimble commented Jul 15, 2019 •

edited by gkalpak

gkalpak left a comment •

edited

ajitsinghkaler left a comment •

edited