You are viewing a plain text version of this content. The canonical link for it is here.

Posted to github@datafusion.apache.org by "2010YOUY01 (via GitHub)" <gi...@apache.org> on 2025/12/10 09:56:24 UTC

[PR] dev: Add CI doc prettier check to local `rust_lint.sh` [datafusion]

2010YOUY01 opened a new pull request, #19254:
URL: https://github.com/apache/datafusion/pull/19254

## Which issue does this PR close?

A small step towards https://github.com/apache/datafusion/issues/19227

## Rationale for this change

## What changes are included in this PR?

- Move doc prettier check command to a local script
- Add this script to the lint-check runner `dev/rust_lint.sh` to make local development easier
(Technically it's neither rust nor lint, but keeping all non functional tests here seem to be the most convenient.)

## Are these changes tested?

<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code

If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
-->

## Are there any user-facing changes?

--
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-unsubscribe@datafusion.apache.org

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

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

Re: [PR] dev: Add CI doc prettier check to local `rust_lint.sh` [datafusion]

Posted by "2010YOUY01 (via GitHub)" <gi...@apache.org>.

2010YOUY01 commented on code in PR #19254:
URL: https://github.com/apache/datafusion/pull/19254#discussion_r2703225368


##########
ci/scripts/doc_prettier_check.sh:
##########
@@ -0,0 +1,57 @@
+#!/usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+SCRIPT_PATH="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/$(basename "${BASH_SOURCE[0]}")"
+
+MODE="--check"

Review Comment:
   We have auto fixes for other lint violations now
   ```
   ./dev/rust_lint.sh --write --allow-dirty
   ```
   - In https://github.com/apache/datafusion/pull/19560
   
   I haven't used it extensively yet, so there may still be some bugs and potential improvements.



-- 
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-unsubscribe@datafusion.apache.org

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


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

Re: [PR] dev: Add CI doc prettier check to local `rust_lint.sh` [datafusion]

Posted by "2010YOUY01 (via GitHub)" <gi...@apache.org>.

2010YOUY01 commented on code in PR #19254:
URL: https://github.com/apache/datafusion/pull/19254#discussion_r2605963279


##########
docs/source/user-guide/metrics.md:
##########
@@ -30,7 +30,7 @@ DataFusion operators expose runtime metrics so you can understand where time is
 | Metric          | Description                                                                                                                                                                                        |
 | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | elapsed_compute | CPU time the operator actively spends processing work.                                                                                                                                             |
-| output_rows     | Total number of rows the operator produces.                                                                                                                                                        |
+| output_rows    | Total number of rows the operator produces.                                                                                                                                                        |

Review Comment:
   injecting this `prettier` violation to ensure CI works as before.



-- 
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-unsubscribe@datafusion.apache.org

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


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