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

Make naming and formatting of blocks and their fields consistent #8173

Open
3 tasks
Pwuts opened this issue Sep 25, 2024 — with Linear · 0 comments
Open
3 tasks

Make naming and formatting of blocks and their fields consistent #8173

Pwuts opened this issue Sep 25, 2024 — with Linear · 0 comments

Comments

Copy link
Member

Pwuts commented Sep 25, 2024

Our automatic "pretty" formatting of field and block names isn't great. Examples:

  • "Read Csv Block"
  • "Request Url"
  • "Api Key"
  • "Rss Url"

These should be set explicitly rather than generated from a class/field name or type name, and imo we also should not be auto-capitalizing every word because aesthetically it just doesn't work.

TODO

  • Fix naming of block classes (e.g. ReadCsvBlock ("Read Csv Block") -> ReadCSVBlock ("Read CSV Block")
  • Add title parameter to Block.__init__ which overrides the auto-formatted title, to be used if our prettifying algorithm isn't compatible with the intended block title
  • Set explicit title on fields that currently aren't properly formatted (e.g. "Request Url", "Api Key")
@Pwuts Pwuts added the platform/blocks label Sep 25, 2024 — with Linear
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant