Skip to content

Review alternate U+005B "[" and U+005D "]" glyph changes as new defaults #363

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

Closed
5 tasks done
chrissimpkins opened this issue Dec 20, 2017 · 26 comments
Closed
5 tasks done
Assignees
Milestone

Comments

@chrissimpkins
Copy link
Member

chrissimpkins commented Dec 20, 2017

Stylistic alternates contributed to alt-hack repository source-foundry/alt-hack@d74f3e4 by @vl4dimir

Review changes in source code text to determine whether these designs are appropriate as new upstream defaults.

TODO:

  • examine code corpora for idiomatic usage of the glyphs x programming language
  • create specimen sheets
  • review design changes
  • remove from alt-hack repo when these shapes become defaults
  • add previous design to alt-hack repository for anyone who wants to revert back to old versions
@chrissimpkins chrissimpkins added this to the v3.002 milestone Dec 20, 2017
@chrissimpkins chrissimpkins self-assigned this Dec 20, 2017
@chrissimpkins chrissimpkins changed the title Review alternate U+005B and U+005D glyph changes as new defaults Review alternate U+005B "[" and U+005D "]" glyph changes as new defaults Dec 21, 2017
@vl4dimir
Copy link
Contributor

@chrissimpkins I'd like to help out with this. Can you point me in the right direction? Maybe I can generate specimen sheets? Not sure what the process is for examining code corpora.

@chrissimpkins
Copy link
Member Author

Here is the repository where we have stored source for review: https://github.com/source-foundry/code-corpora

David recently performed this analysis https://github.com/source-foundry/code-corpora/blob/master/scripts/results/punctuation.txt

I think that it would be worth expanding that slightly here to see if we can find idiomatic uses of the two symbols across the bodies of source code and create new specimen sheets for these glyphs. Then we can begin to examine your changes with adjacent glyphs that we would expect them to be seen near in source code.

Feel free to dig in whenever you have free time. I will be available to pitch in after I get this next release out.

@burodepeper
Copy link
Member

@vl4dimir Please attach an image of your new designs, comparing them to the old design

@vl4dimir
Copy link
Contributor

@chrissimpkins Thanks, I'm now taking a look at the corpora and David's analysis. Not sure what you mean by "idiomatic use"? Do you guys use some kind of automated process of examining readability?

@burodepeper Here are the images for left bracket and right bracket.

@burodepeper
Copy link
Member

@vl4dimir Do you have a screenshot comparing them to the normal brackets?

@vl4dimir
Copy link
Contributor

@burodepeper I don't, but I can create them. How would you like it done? Just the glyphs side by side, or as part of some example code?

@burodepeper
Copy link
Member

Preferably on top of each other, so it's easiest to see where they differ. Take this image as an example.

@chrissimpkins
Copy link
Member Author

chrissimpkins commented Dec 22, 2017

@vl4dimir in case you were not aware @burodepeper is David :) You are now speaking directly with him.

We do not have a formal process at the moment. My suggestion is that we review how ASCII glyphs are used across each of the source types in the corpora as research work to determine what design changes (1) may be needed; (2) do in the context of those source code idioms (i.e. what users will see with a significant re-design of a commonly viewed source code glyph). Then discuss based upon these semi-objective/semi-subjective assessments. There will not be a pure objective approach, but we can make it somewhat systematic for important glyphs (which we consider in our design document to be all ASCII set glyphs)

@chrissimpkins
Copy link
Member Author

@vl4dimir something that you are still interested in reviewing for upstream defaults? We can start to explore this in source code this week if you have time for it.

@vl4dimir
Copy link
Contributor

@chrissimpkins I'm swamped with client work for the next couple of weeks unfortunately 😞

@chrissimpkins
Copy link
Member Author

@vl4dimir No worries! When time frees up let me know and we can work on this if it is still something of interest.

@vl4dimir
Copy link
Contributor

@chrissimpkins Yes, it definitely is!

@chrissimpkins
Copy link
Member Author

I will start working on this over the next week or so. Will post images when I have them. Need to review some bodies of source text to come up with specimens to test changes here. We will look at idiomatic usage. Please feel free to weigh in based upon languages that you use (anyone out there). This will be a broadly used set of glyphs and we will take a broad look across source text.

@vl4dimir
Copy link
Contributor

vl4dimir commented Feb 3, 2018

@chrissimpkins FWIW I've been using this modified version extensively for the past couple of months in Swift and C# and have seen zero issues. Would it help if I post screenshots? I'm still confused by the "idiomatic usage" nomenclature, honestly 😄

@chrissimpkins
Copy link
Member Author

I want to explore how brackets are used in different bodies of source. I am just going to do a bit of systematic exploration of these shapes next to glyphs that they commonly appear near in source text. Nothing for you to do at this point. I will create specimen sheets and will post the text for them here when available. Then we can both start laying out code with the changes and see where we are and whether we need additional modifications.

@chrissimpkins
Copy link
Member Author

chrissimpkins commented Feb 3, 2018

These are glyphs that are broadly used across many/most programming languages using programming idioms defined by the language. The goal is to see how and how we improve upon the display if that is even possible broadly across languages.

@chrissimpkins
Copy link
Member Author

chrissimpkins commented Feb 4, 2018

@vl4dimir here is an example of what I mean. This URL performs a Sourcegraph search on the [ glyph across multiple source code types in our Code Corpora repository:

https://sourcegraph.com/search?q=repo%3A^github\.com%2Fsource-foundry%2Fcode-corpora%24+\[+file%3A\.(c|h|cc|py|go|java|js|php|rb)%24

This type of lexical analysis is what we will review to determine how these glyphs are used in programming language specific idioms.

@chrissimpkins
Copy link
Member Author

chrissimpkins commented Feb 4, 2018

Then we will create some specimens to replicate these and examine how the spacing & shape here changes the appearance.

@chrissimpkins
Copy link
Member Author

@vl4dimir mind PR'ing in your UFO .glyphs files when you have a chance? I will build sets and we can start taking a look at this whenever convenient for you.

@vl4dimir
Copy link
Contributor

vl4dimir commented Feb 9, 2018

@chrissimpkins Will do, this weekend. Sorry for not responding quickly, super busy week.

@chrissimpkins
Copy link
Member Author

@vl4dimir no rush! There is plenty of work to do for the next release and we can push this back as needed/time allows. For whenever it is convenient for you to do it.

@chrissimpkins
Copy link
Member Author

btw base on dev branch when you do submit this

@vl4dimir
Copy link
Contributor

@chrissimpkins ➡️ #393

@chrissimpkins
Copy link
Member Author

Updated this TODO list with outstanding items from PR #393 before we push the merged design changes to main.

@chrissimpkins
Copy link
Member Author

Design changes are complete here and source in dev branch is current with these changes. These changes will be part of the v3.003 release.

@chrissimpkins
Copy link
Member Author

Removed @vl4dimir alt-hack designs that are now the new defaults here and added Hack v3.002 and prior default left and right brackets to the alt hack repository for anyone who would like to revert to those designs.

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

No branches or pull requests

3 participants