You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "qleroy (via GitHub)" <gi...@apache.org> on 2024/01/24 20:48:16 UTC

[PR] chore(RESOURCES): fix markdown for table formatting [superset]

qleroy opened a new pull request, #26789:
URL: https://github.com/apache/superset/pull/26789

   Just fixing markdown to restore the preview !


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] chore(RESOURCES): fix markdown for table formatting [superset]

Posted by "qleroy (via GitHub)" <gi...@apache.org>.
qleroy commented on PR #26789:
URL: https://github.com/apache/superset/pull/26789#issuecomment-1910727692

   I just removed the last bit `|---|` on line 2
   which was added by mistake some time ago.
   It breaks the formatting and you cannot preview it as a table, for example on GitHub.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] chore(RESOURCES): fix markdown for table formatting [superset]

Posted by "sfirke (via GitHub)" <gi...@apache.org>.
sfirke merged PR #26789:
URL: https://github.com/apache/superset/pull/26789


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] chore(RESOURCES): fix markdown for table formatting [superset]

Posted by "sfirke (via GitHub)" <gi...@apache.org>.
sfirke commented on PR #26789:
URL: https://github.com/apache/superset/pull/26789#issuecomment-1910918848

   @john-bodley here is how this .md page is rendering currently:
   ![image](https://github.com/apache/superset/assets/7569808/4d4bc83e-8ba7-466d-8fa8-753d44f8fb58)
   
   thanks @qleroy for the fix!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] chore(RESOURCES): fix markdown for table formatting [superset]

Posted by "john-bodley (via GitHub)" <gi...@apache.org>.
john-bodley commented on PR #26789:
URL: https://github.com/apache/superset/pull/26789#issuecomment-1910720222

   Thanks @qleroy. I believe the table is auto-formatted via IDEs, which typically makes markdown tables more readable. What do you mean by preview?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] chore(RESOURCES): fix markdown for table formatting [superset]

Posted by "john-bodley (via GitHub)" <gi...@apache.org>.
john-bodley commented on PR #26789:
URL: https://github.com/apache/superset/pull/26789#issuecomment-1910740732

   @qleroy would you mind running `tox -e pre-commit` locally? I _believe_ that `prettier` will reformat the table so that the columns are aligned. 
   
   cc @michael-s-molina 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] chore(RESOURCES): fix markdown for table formatting [superset]

Posted by "sfirke (via GitHub)" <gi...@apache.org>.
sfirke commented on PR #26789:
URL: https://github.com/apache/superset/pull/26789#issuecomment-1910939323

   Oops, sorry this wasn't the proper structural fix. I don't completely follow the correct way to address this but would like to learn, maybe by looking at a PR that does it?
   
   I am unfamiliar with maintaining a table like this, I had just noticed it was broken and put out a call in Slack asking for a fix from the community.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] chore(RESOURCES): fix markdown for table formatting [superset]

Posted by "qleroy (via GitHub)" <gi...@apache.org>.
qleroy commented on PR #26789:
URL: https://github.com/apache/superset/pull/26789#issuecomment-1910762510

   Will try.
   Sorry for the confusion but the problem is not so the formatting but the additional column `|---|` only on line 2 that breaks the whole table


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] chore(RESOURCES): fix markdown for table formatting [superset]

Posted by "john-bodley (via GitHub)" <gi...@apache.org>.
john-bodley commented on PR #26789:
URL: https://github.com/apache/superset/pull/26789#issuecomment-1910928125

   @sfirke my comment was related to how the table presented pre-rendering. There's auto-formatters which add whitespace to ensure that the columns align which help when reading the table in an IDE.
   
   I realize that the fix addressed an issue with the markdown structure, but it augmented the formatting and thus whitespace is no longer preserved.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] chore(RESOURCES): fix markdown for table formatting [superset]

Posted by "qleroy (via GitHub)" <gi...@apache.org>.
qleroy commented on PR #26789:
URL: https://github.com/apache/superset/pull/26789#issuecomment-1910908477

   Cc @sfirke 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] chore(RESOURCES): fix markdown for table formatting [superset]

Posted by "qleroy (via GitHub)" <gi...@apache.org>.
qleroy commented on PR #26789:
URL: https://github.com/apache/superset/pull/26789#issuecomment-1911002407

   I just checked that the pre-commit hooks pass and pre-commit outputs the same file.
   I my fix-md-formatting branch, the first commit that removes `|---|` is necessary, the second way removing whitespace is not necessary and pre-commit ignores the difference as well
   <img width="553" alt="Screenshot 2024-01-25 at 21 38 10" src="https://github.com/apache/superset/assets/9881262/cdf0de04-9cc9-46f3-bfb1-64eebfea95b4">
   
   
   ```
   tox -e pre-commit
   pre-commit: commands[0]> pre-commit run --all-files
   auto-walrus..............................................................Passed
   pyupgrade................................................................Passed
   pycln....................................................................Passed
   isort....................................................................Passed
   mypy.....................................................................Passed
   pip-compile-multi verify.................................................Passed
   check docstring is first.................................................Passed
   check for added large files..............................................Passed
   check yaml...............................................................Passed
   debug statements (python)................................................Passed
   fix end of files.........................................................Passed
   trim trailing whitespace.................................................Passed
   black....................................................................Passed
   prettier.................................................................Passed
   Blacklist................................................................Passed
   ```


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] chore(RESOURCES): fix markdown for table formatting [superset]

Posted by "michael-s-molina (via GitHub)" <gi...@apache.org>.
michael-s-molina commented on PR #26789:
URL: https://github.com/apache/superset/pull/26789#issuecomment-1910923498

   @sfirke We should commit using the same output generated by pre-commit. If it's generating this weird preview, we need to fix the formatter. The problem of committing a manually generated format is that every time this file is touched and formatted by pre-commit, we'll get a diff.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] chore(RESOURCES): fix markdown for table formatting [superset]

Posted by "sfirke (via GitHub)" <gi...@apache.org>.
sfirke commented on PR #26789:
URL: https://github.com/apache/superset/pull/26789#issuecomment-1910921570

   Just confirmed that it's rendering correctly again:
   
   ![image](https://github.com/apache/superset/assets/7569808/6a50e037-90e1-4bd6-8b29-425fc90d8f3b)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org