databrickslabs / databrickslabs/lsql

[BUG]: `databricks labs lsql fmt` moves comment to top of file possibly breaking the widget header

Open
#236 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
39
Forks
8
PR merge metrics
No merged PRs in 30d

Description

databricks labs lsql fmt moves comment to top of file possibly breaking the widget header. See screenshot below, with left before the format command and right after:

Screenshot 2024-07-24 at 14 36 21

See this comment for context

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the databricks labs lsql fmt command and reviewing the linked pull-request discussion for the formatter behavior. Reproduce the before-and-after output shown in the issue, then verify that formatting no longer moves comments in a way that breaks the widget header.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.