Skip to content

formal-homework:0.1.0#4239

Open
daqnal wants to merge 2 commits intotypst:mainfrom
daqnal:main
Open

formal-homework:0.1.0#4239
daqnal wants to merge 2 commits intotypst:mainfrom
daqnal:main

Conversation

@daqnal
Copy link

@daqnal daqnal commented Mar 2, 2026

I am submitting

  • a new package
  • an update for a package

Description: Provides macros to easily setup a formal homework document, useful for many university students like myself.

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

@daqnal daqnal temporarily deployed to Package Check March 2, 2026 05:49 — with GitHub Actions Inactive
@typst-package-check typst-package-check bot added the new A new package submission. label Mar 2, 2026
@elegaanz elegaanz self-assigned this Mar 3, 2026
Copy link
Member

Choose a reason for hiding this comment

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

Can you please delete that file? It is not used anywhere and we try to keep this repository as light as possible. Alternatively, if you think it is valuable, can you link to it from your README so that users who may find it useful can actually access it? Typst Universe only displays the README and doesn't provide a way to browse all files of a package.

license = "GPLv3"
description = "Submit homeworks with simplicity and formality."

repository = "https://github.com/daqnal/formal-homework"
Copy link
Member

Choose a reason for hiding this comment

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

Can you make this repository public please (or actually create it if it just doesn't exist yet)?

entrypoint = "lib.typ"

authors = ["<@daqnal>"]
license = "GPLv3"
Copy link
Member

Choose a reason for hiding this comment

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

The correct identifier is GPL-3.0.



#let hw(
title_text: none,
Copy link
Member

Choose a reason for hiding this comment

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

As reported by the automated CI checks, Typst tends to use kebab-case for variable, function and parameter names. Unless you have a strong preference for snake_case, can you update the names here (and in your README)?

Copy link
Contributor

@omentic omentic left a comment

Choose a reason for hiding this comment

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

This is a pretty template. The name is a little generic, though!

#title[Homework #number Submission]
]

#if class != none [#class]
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe you can just do #class here. (Same with #author, #due-date).

…iables to kebab case; simplified boolean logic; updated readme
@daqnal daqnal temporarily deployed to Package Check March 4, 2026 18:58 — with GitHub Actions Inactive
@daqnal
Copy link
Author

daqnal commented Mar 4, 2026

Thanks for the feedback. Sorry I did not review it more thoroughly to catch those fixes. At some point, I agree it would be nice to have a more creative name, but nothing is coming to mind right now.

I set the license identifier to GPL-3.0, but it seems that the check still failed. What should I change for that to be fixed?

@elegaanz
Copy link
Member

elegaanz commented Mar 5, 2026

Ah yes, my bad. This one is deprecated, you should use GPL-3.0-only or GPL-3.0-or-later (depending on whether you want forward compatibility or not).

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.

3 participants