search

theRAPTLab / gsgo

GEM-STEP Foundation repo migrated from GitLab June 2023
1 stars 1 forks source link

Updated comment styles - [merged] #728

Closed benloh closed 1 year ago

benloh commented 2 years ago

In GitLab by @jdanish on Sep 27, 2022, 09:16

Merges dev-jd/help-and-styling -> dev-next

Updated comment styles

For a summary of the colors and reasons behind them see: https://docs.google.com/document/d/1E1NtwTL1bWH5CGkcn4F9PZFXtFBGG8_GDF-IL9NdQWo/edit

benloh commented 2 years ago

In GitLab by @jdanish on Sep 27, 2022, 09:16

requested review from @benloh

benloh commented 2 years ago

NOTE this requires the latest art-assets projects: aa78baa3ec21af5b6ca6cce74503d24bddff8bc3

benloh commented 2 years ago

@RaptLab It looks like you've changed the formatting the for the whole file to use 4 spaces. Two points here:

  1. Please be sure to load the gem workspace and install all extensions in Visual Studio code so that we have consistent formatting across all files. See https://www.dropbox.com/sh/yaij27byhzdxnvk/AABpem93CjEX4bU4tPLMLe1ua/GEMSTEP/gsgo-repo-docs/20-tooling/20-dev-install.md?dl=0 for rough instructions, or ping me for help. I realize these instructions got moved with an earlier docs update, so I'll try to get them back in.

  2. If you do find yourself needing to change formatting for a file (e.g. you're opening an old file that did not conform to the Prettier settings, first commit the prettified changes, then your code changes in a separate commit. That helps everyone see what's changed.

benloh commented 2 years ago

Overall, I love the concept of using Emoticons to call out things. I'm a little on the fence about using them as the key for triggering the comment code, mostly because they're more prone to error (e.g. you have to select the right icon, and you have to have a space, and you have to have "WHAT"). But maybe that's because I'm an old school guy who just isn't used to using emoticons all the time...

benloh commented 2 years ago

changed this line in version 2 of the diff

benloh commented 2 years ago

added 1 commit

Compare with previous version

benloh commented 2 years ago

In GitLab by @jdanish on Sep 28, 2022, 09:28

I agree with the concern but have struggled to find better ideas. For now, though. I think this is a good way to test if it matters / helps and then either modify the styles if needed, or consider putting this into the comment type in the future gui?

benloh commented 2 years ago

@RaptLab @jdanish I've just pushed lint fixes. Please pull the latest before making more commits.

benloh commented 2 years ago

Yeah it works for now and is relatively easy to change. I was considering inserting the emoticons via CSS content, but then you lose out on the simple triggering.

benloh commented 2 years ago

mentioned in commit ddcf595163de3c6bbb894f7ff905f198738718c4