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

docs: update contributor guide (format toml/inte test) #9301

Merged
merged 1 commit into from
Feb 22, 2024

Conversation

SteveLauC
Copy link
Contributor

Which issue does this PR close?

no

Rationale for this change

What changes are included in this PR?

  1. Update the docs on integration test, dataframe is no longer a test target:

    $ cargo t -p datafusion --test dataframe
    error: no test target named `dataframe`.
    Available test targets:
        config_from_env
        core_integration
        custom_sources
        fifo
        fuzz
        memory_limit
        parquet_exec
        path_partition
        simplification
        tpcds_planning
        user_defined_integration
  2. Add docs on how to format .toml files, ref: chore: use taplo to format Cargo.toml manifests #9263 Proposal: replace toml formatter with taplo #9262

Are these changes tested?

Are there any user-facing changes?

no


> Refer to the [Installation section][doc] on other ways to install it.
>
> doc: https://taplo.tamasfe.dev/cli/installation/binary.html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> doc: https://taplo.tamasfe.dev/cli/installation/binary.html
> [doc]: https://taplo.tamasfe.dev/cli/installation/binary.html

Is this link created for the "Installation section"?

Currently it is displayed as:
截屏2024-02-21 16 06 53

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching it! I missed that []

@SteveLauC SteveLauC force-pushed the docs/update_contributor_doc branch from 24bd2bb to 9651e6c Compare February 21, 2024 08:15
Copy link
Member

@jonahgao jonahgao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

Copy link
Contributor

@Jefffrey Jefffrey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice 👍

For Rust developers, you can install it via:

```sh
$ cargo install taplo-cli --locked
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$ cargo install taplo-cli --locked
cargo install taplo-cli --locked

Makes sense to show prompt but can be annoying when copying from that code block (via the copy button)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@waynexia
Copy link
Member

Thanks for this!

@SteveLauC SteveLauC force-pushed the docs/update_contributor_doc branch from 9651e6c to 45eb91b Compare February 21, 2024 23:20
@waynexia waynexia merged commit 91f3eb2 into apache:main Feb 22, 2024
4 checks passed
@SteveLauC SteveLauC deleted the docs/update_contributor_doc branch February 22, 2024 02:56
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

Successfully merging this pull request may close these issues.

5 participants