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

tinyset:0.1.0 #1233

Merged
merged 6 commits into from
Nov 6, 2024
Merged

tinyset:0.1.0 #1233

merged 6 commits into from
Nov 6, 2024

Conversation

SylvanFranklin
Copy link
Contributor

I am submitting

  • a new package
  • an update for a package

Tinyset is a minimal and opinionated library that provides a handful of utility functions for writing pure math pros for homework / psets. It contains a prebuilt header along with several environments for proof / question / sub question etc. I also added some custom plain English shorthand for common math symbols such as implication.

I have read and followed the submission guidelines and, in particular, I

  • selected a name that isn't the most obvious or canonical name for what the package does
  • added a typst.toml file with all required keys
  • added a README.md with documentation for my package
  • have chosen a license and added a LICENSE file or linked one in my README.md
  • tested my package locally on my system and it worked
  • excluded PDFs or README images, if any, but not the LICENSE
  • ensured that my package is licensed such that users can use and distribute the contents of its template directory without restriction, after modifying them through normal use.

@SylvanFranklin SylvanFranklin changed the title added tinyset package tinyset:0.1.0 Nov 5, 2024
@typst-package-check typst-package-check bot added the new A new package submission. label Nov 5, 2024
@SylvanFranklin
Copy link
Contributor Author

Hullo! I read the warning regarding kebab case but did not realize that this name would trigger it. I could update the name if that would better, but I don't think of the two words as separate, but rather as a hybrid name. Thanks.

Copy link
Member

@elegaanz elegaanz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the warning, don't worry about it, kebab-case is not mandatory in any case, and here it makes sense to keep the capital letter.

set par(justify: true)
}

// custom shorthands, feel free to comment these out if they are in the way.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For information it is not possible for package users to edit the contents of a package.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right! Thanks

#class \
#name - Homework #number
]
set par(justify: true)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that will work as expected, since set rules are scoped. This would only apply until the end of the current scope, which is on the next line. If you want to apply this rule to the whole document, the correct way to do it is to use a global show rule. There is a tutorial on how to create one.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes of course! Thanks for pointing that out, I will move the show rules into the individual components, just for ease of use of the library.

@elegaanz
Copy link
Member

elegaanz commented Nov 6, 2024

Thanks :)

@elegaanz elegaanz merged commit 56b8f94 into typst:main Nov 6, 2024
1 of 2 checks passed
@SylvanFranklin
Copy link
Contributor Author

Thank you for being so friendly and welcoming to a beginner! I'm glad the the Typst foundation is in such good hands, this really made my day!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new A new package submission.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants