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

Reformat Column comments #1011

Open
Z2Flow opened this issue Feb 20, 2024 · 1 comment
Open

Reformat Column comments #1011

Z2Flow opened this issue Feb 20, 2024 · 1 comment

Comments

@Z2Flow
Copy link

Z2Flow commented Feb 20, 2024

This stems from reverse-engineering a PostgreSQL database…
Add the ability to move column comments to the next line, and indented 'n' spaces.
Also soft-wrap to column 'm' (default 80), and interpret newline characters (\n).

Currently columns with long comments cause the page width to extend to the end of the comment making it difficult to access the datatype as it overflows the window.

E.g. current formatting:

# assembly_failures(The list of causes of failure for an assembly.\n This is a template field copied to the Test when it is created.\n This array creates a list of checkboxes in the form. :jsonb

Proposed formatting:

#  assembly_failures                                       :jsonb
#       The list of causes of failure for an assembly.
#       This is a template field copied to the Test when it is created.
#       This array creates a list of checkboxes in the form.

Version

  • annotate version: 3.2.0
  • rails version: 7.1.3
  • ruby version: 3.3.0
@mvastola
Copy link

mvastola commented May 8, 2024

Yes, please! Was about to submit a PR to simply add a space between the field name and the (, but this is way better.

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

No branches or pull requests

2 participants