Page MenuHomePhabricator

[web] [docs] add documentation to viewing icons in icomoon
ClosedPublic

Authored by benschac on Mar 10 2022, 10:41 AM.
Tags
None
Referenced Files
F3675433: D3398.diff
Mon, Jan 6, 8:59 AM
Unknown Object (File)
Tue, Dec 31, 9:17 AM
Unknown Object (File)
Sun, Dec 29, 8:23 PM
Unknown Object (File)
Sun, Dec 29, 8:23 PM
Unknown Object (File)
Sun, Dec 29, 8:23 PM
Unknown Object (File)
Sun, Dec 29, 8:23 PM
Unknown Object (File)
Sun, Dec 29, 8:23 PM
Unknown Object (File)
Fri, Dec 27, 9:39 AM

Details

Summary

Add a comment in the icon component about how to view the icons in icomoon.

This is documentation. per the rules (https://www.notion.so/commapp/Diff-Review-Rules-addfc3a41b324c7d8ba636dd9dcefeba) adding ashoat.

Test Plan

go through the steps and make sure they make sense to you and anyone else on the team.

Diff Detail

Repository
rCOMM Comm
Branch
arcpatch-D3398
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

benschac added a reviewer: ashoat.
benschac edited the summary of this revision. (Show Details)
benschac added inline comments.
web/SWMansionIcon.react.js
12 ↗(On Diff #10273)

should I add the directory to be a bit more descriptive here, or do you think most folks will know to just search for AppIcons.json in the project?

Minor nit but if I remember correctly (cc @ashoat), the team generally avoids multi-line comments with /* and */ and instead prefers starting each line with //

Not sure of the reasoning or context, but I vaguely remember something like that being a "rule"

ashoat requested changes to this revision.Mar 10 2022, 8:04 PM
In D3398#91898, @atul wrote:

Minor nit but if I remember correctly (cc @ashoat), the team generally avoids multi-line comments with /* and */ and instead prefers starting each line with //

Not sure of the reasoning or context, but I vaguely remember something like that being a "rule"

Yeah I think this is generally reflective of the pattern that's emerged in the codebase, and it's probably better to stick to it. Not that it really matters...

web/SWMansionIcon.react.js
8–15 ↗(On Diff #10273)

Please keep all lines to max 80 chars width!

12 ↗(On Diff #10273)

Probably doesn't hurt to put the full directory in

This revision now requires changes to proceed.Mar 10 2022, 8:04 PM
In D3398#91898, @atul wrote:

Minor nit but if I remember correctly (cc @ashoat), the team generally avoids multi-line comments with /* and */ and instead prefers starting each line with //

Not sure of the reasoning or context, but I vaguely remember something like that being a "rule"

For multi-line comments IMO find them waaaay easier to read. Going to leave it here for now if it's not a big deal.

web/SWMansionIcon.react.js
8–15 ↗(On Diff #10273)

Sorry, my editor does it by default. I'm not sure why it didn't format it by default.

ashoat added inline comments.
web/SWMansionIcon.react.js
11–16

Some nits:

  1. Some of these lines end with periods but others don't
  2. AppIcons.json is mentioned twice... why not just say "then upload web/icons/AppIcons.json and click load"?
  3. You have the sentence construction "Do X, then do Y then do Z" which is pretty messy. I'd avoid saying "then" twice like that
This revision is now accepted and ready to land.Mar 11 2022, 7:51 AM
web/SWMansionIcon.react.js
13 ↗(On Diff #10307)

One of my nits from last time was not addressed:

Some of these lines end with periods but others don't