timsaucer commented on PR #1242:
URL: 
https://github.com/apache/datafusion-python/pull/1242#issuecomment-3315950365

   I'm running CI now!
   
   It looks like there were a couple of changes that we needed and I pushed. 
First there were whitespace errors and some lines that were too long. We use 
`ruff` for our linter and it is configured with 
[pre-commit](https://pre-commit.com/) so you can often catch these problems 
before you push to github. If you're not familiar with it, I highly suggest 
installing and using it. It's a very useful tool.
   
   The second was that the documentation did not render correctly. 
RestructuredText (rst) can be fickle if you haven't used it before. It needs 
double back ticks rather than single ticks to indicate something should render 
as monospaced variables. Also in order to get the python example to work the 
line before it needs to end with a double colon `::`. Like I said, it's picky 
when it comes to how these need to be written in order to render properly. But 
it's been a long established method for code documentation in Python, so often 
work becoming familiar with.
   
   Thank you again for the PR! Assuming CI passes I'll merge this.


-- 
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: github-unsubscr...@datafusion.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org
For additional commands, e-mail: github-h...@datafusion.apache.org

Reply via email to