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

Style Guide/Consistent style #64

Open
Robadob opened this issue Mar 9, 2025 · 0 comments
Open

Style Guide/Consistent style #64

Robadob opened this issue Mar 9, 2025 · 0 comments

Comments

@Robadob
Copy link
Member

Robadob commented Mar 9, 2025

Items raised whilst working through @JostMigenda's additions.

  • Title case
  • long numbers in code (e.g. break them up with _)
  • quote style (e.g. regular vs typographic quotes)
  • x vs multiplication symbol
  • referring to functions (from code examples) in the text (e.g. foo() rather than foo)
  • avoid first person
  • Prefer to avoid raw links, (e.g. link some descriptive text instead, carpentries CI will nag if the text is just here)

Not sure what else would be relevant.

Then we'd obviously need to review the site to check they're implemented.

JostMigenda added a commit to JostMigenda/pando-python that referenced this issue Mar 10, 2025
Should change these consistently across the whole course, see RSE-Sheffield#64
Robadob pushed a commit that referenced this issue Mar 10, 2025
Should change these consistently across the whole course, see #64
github-actions bot pushed a commit that referenced this issue Mar 10, 2025
Auto-generated via `{sandpaper}`
Source  : 5725fea
Branch  : main
Author  : Jost Migenda <[email protected]>
Time    : 2025-03-10 16:01:26 +0000
Message : resetting some typographic changes
Should change these consistently across the whole course, see #64
github-actions bot pushed a commit that referenced this issue Mar 10, 2025
Auto-generated via `{sandpaper}`
Source  : 9305829
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2025-03-10 16:02:22 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 5725fea
Branch  : main
Author  : Jost Migenda <[email protected]>
Time    : 2025-03-10 16:01:26 +0000
Message : resetting some typographic changes
Should change these consistently across the whole course, see #64
JostMigenda added a commit to JostMigenda/pando-python that referenced this issue Mar 10, 2025
Should make typographic changes consistently across the whole course, see RSE-Sheffield#64
JostMigenda added a commit to JostMigenda/pando-python that referenced this issue Mar 10, 2025
Should make typographic changes consistently across the whole course, see RSE-Sheffield#64
JostMigenda added a commit to JostMigenda/pando-python that referenced this issue Mar 10, 2025
Should make typographic changes consistently across the whole course, see RSE-Sheffield#64
github-actions bot pushed a commit that referenced this issue Mar 11, 2025
Auto-generated via `{sandpaper}`
Source  : 9305829
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2025-03-10 16:02:22 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 5725fea
Branch  : main
Author  : Jost Migenda <[email protected]>
Time    : 2025-03-10 16:01:26 +0000
Message : resetting some typographic changes
Should change these consistently across the whole course, see #64
JostMigenda added a commit that referenced this issue Mar 12, 2025
Should make typographic changes consistently across the whole course, see #64
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

No branches or pull requests

1 participant