Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[Not a PR] Reaction to the tutorial #26

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

Conversation

theo-m
Copy link

@theo-m theo-m commented May 25, 2022

Cool tutorial! It shows a good picture of what to expect and what it's meant for. Perhaps having the full file linked somewhere to get a sense of what it looks like with the legal text would be helpful.

Mostly nitpicking, but:

  • "algebraic data type" is a barbarism that isn't welcome - in my opinion, it's better to gradually introduce abstractions when they're needed.
  • showing error outputs would help contextualize things, perhaps out of scope for a tutorial?

Algebraic data type is a barbarism that isn't welcome - in my opinion.

Showing error outputs would help contextualize things.
@theo-m
Copy link
Author

theo-m commented May 25, 2022

Feel free to close anytime btw!

@EmileRolley
Copy link
Collaborator

Hi @theo-m,

Thanks for your feedback!

Perhaps having the full file linked somewhere to get a sense of what it looks like with the legal text would be helpful.

I'm not sure what you mean by that. Do you mean having a link to the tutorial.catala_en file or having real world example, such as the French family benefits computation?

Mostly nitpicking, but:

  • "algebraic data type" is a barbarism that isn't welcome - in my opinion, it's better to gradually introduce abstractions when they're needed.
  • showing error outputs would help contextualize things, perhaps out of scope for a tutorial?

For the rest, I'll let @denismerigoux answer you :)

@EmileRolley EmileRolley requested a review from denismerigoux May 31, 2022 09:18
@denismerigoux
Copy link
Contributor

Thanks @theo-m !

"algebraic data type" is a barbarism that isn't welcome - in my opinion, it's better to gradually introduce abstractions when they're needed.

It's actually the precise name for the thing I was explaining in simple terms in that sentence. But if you think that may scare new users, I'm fine with removing it :)

showing error outputs would help contextualize things, perhaps out of scope for a tutorial?

Yep now we have full pandoc markdown support for the non-Catala parts so we can pretty-print error outputs in the tutorial !

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants