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

Add draft style guide #70

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add draft style guide #70

wants to merge 1 commit into from

Conversation

marius311
Copy link
Collaborator

Adding here for comments, before going through the code and actually implementing this.

@codecov-commenter
Copy link

codecov-commenter commented Jun 30, 2022

Codecov Report

Merging #70 (cadbcda) into main (de08e4d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #70   +/-   ##
=======================================
  Coverage   46.09%   46.09%           
=======================================
  Files           7        7           
  Lines         692      692           
=======================================
  Hits          319      319           
  Misses        373      373           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update de08e4d...cadbcda. Read the comment docs.

@xzackli
Copy link
Owner

xzackli commented Jul 2, 2022

My other concern would be guidance on unicode usage.

@marius311
Copy link
Collaborator Author

My other concern would be guidance on unicode usage.

Agree that should definitely be added to the guide.

Unicode right now doesn't have a complete set of subscripts and superscripts, and stuff like \prime\prime and \pprime worry me a bit.

Yea, for this reason I'd say discourage broad use. So I like that we're doing Ω_r, Ω_b, Ω_m etc... I would actually consider getting rid of the _ though, I don't think its any less clear without.

Even usage of \bb, \bf etc can cause problems, due to bugs in other stuff (jupyterlab/jupyterlab#9524)

Yea, I'm not married to 𝕡 type stuff although I do like it alot. Would be good to standardize the naming a bit, eg 𝕡, bg, ih, etc... should be one style.

certain monospace fonts don't have great math support

I'd say we recommend Julia Mono and in the guide say that if it doesn't look good in Julia Mono don't use it, but if it does fair game.

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.

3 participants