source-to-class-diagram:0.1.0#4697
Conversation
| exclude = ["tests/", "docs/", "gallery/"] | ||
|
|
||
| [template] | ||
| path = "exemplos" |
There was a problem hiding this comment.
I'm not entirely sure a template is relevant here. I feel like this is more a package that you would import in larger projects rather than something you want to use standalone. And even in that case, importing the package and applying the unique show rule is not really worth a template in my opinion. Is there a particular reason you may want to start a project from the setup in exemplos/?
| @@ -0,0 +1,17 @@ | |||
| [package] | |||
| name = "source-to-class-diagram" | |||
There was a problem hiding this comment.
This name is too descriptive, which we forbid. Can you please pick another name that is more distinctive and unique?
| [package] | ||
| name = "source-to-class-diagram" | ||
| version = "0.1.0" | ||
| compiler = "0.14.2" |
There was a problem hiding this comment.
The compiler field is a minimum version, so unless you explicitly require the latest patch release, changing it to 0.14.0 will allow using this package with a slightly outdated compiler. If you know for sure that you support older versions because you don't use any recent Typst feature, you can even use a lower version number.
| @@ -0,0 +1,158 @@ | |||
| # source-to-class-diagram | |||
|
|
|||
| Geração de Diagramas de Classe UML a partir de código-fonte Java ou C# diretamente no Typst, construído sobre o engine CeTZ. | |||
There was a problem hiding this comment.
It is generally appreciated to have at least the first sentence of the README in English to give a bit more context about the package to the broader Typst community. Here, since this package can be useful to people who don't speak Portuguese too, I even think it would be nice to have the full README in English (as this is the "default" language of the community). But I can understand that you may feel more comfortable using Portuguese: you don't have to translate the full README if you don't feel like doing it.
There was a problem hiding this comment.
I'm not sure what the purpose of that file is. In case it is no longer used, can you remove it please?
I am submitting
UML Class Diagrams for Typst, built on CeTZ. Supports Java and Csharp syntax with pluggable grammars.
I have read and followed the submission guidelines and, in particular, I
typst.tomlfile with all required keysREADME.mdwith documentation for my packageLICENSEfile or linked one in myREADME.mdexcluded PDFs or README images, if any, but not the LICENSE