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: enable rustfmt for doc comments #187

Merged
merged 6 commits into from
Aug 21, 2024

Conversation

CommanderStorm
Copy link
Contributor

format_code_in_doc_comments is a nightly rustfmt feature. (tracking issue: rust-lang/rustfmt#3348)
I think this might be helpfull.

Usually, I would not consider this being an option, but given that already some other rustfmt feature are enabled... 😉

Copy link
Contributor

@DDtKey DDtKey left a comment

Choose a reason for hiding this comment

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

Usage of nightly features for rustfmt is quite common. Looks reasonable, let"s enable

However it likely requires to update CI workflow and it can affect formatting of other code

@CommanderStorm
Copy link
Contributor Author

CommanderStorm commented Aug 21, 2024

I have split out the CI part to #188 to get rid of the log-warnings

@DDtKey DDtKey merged commit de349b6 into testcontainers:main Aug 21, 2024
6 checks passed
@CommanderStorm CommanderStorm deleted the fmt_doc_comments branch August 21, 2024 15:32
@github-actions github-actions bot mentioned this pull request Aug 31, 2024
DDtKey pushed a commit that referenced this pull request Aug 31, 2024
## 🤖 New release
* `testcontainers-modules`: 0.9.0 -> 0.10.0

<details><summary><i><b>Changelog</b></i></summary><p>

<blockquote>

## [0.10.0] - 2024-08-31

### Bug Fixes

- Doc-test failures
([#186](#186))

### Documentation

- Added docs for Apache ZooKeeper
([#184](#184))
- Documented all ports which containers at least expose
([#183](#183))
- Enable `rustfmt` for doc comments
([#187](#187))
- Fixed rustfmt violation in the `openldap` module
([#189](#189))
- Fixed a bit of missing docs in the openldap module
([#191](#191))
- Complete the documentation for the meilisearch module
([#192](#192))
- Complete the `*_PORT` documentation
([#195](#195))
- Add `pub mod` docs
([#193](#193))
- Documents the neo4j plugins
([#194](#194))

### Features

- Added an `OpenLDAP` testcontainer module
([#180](#180))
- Add support for `apache\kafka` docker image
([#178](#178))
- [**breaking**] Update `testcontainers` to 0.22.0
([#203](#203))

### Miscellaneous Tasks

- Changed from `actions-rs` to a more maintained CI alternative
([#188](#188))

### Refactor

- [**breaking**] Changed `KAFKA_PORT` to a `ContainerPort`
([#185](#185))

<!-- generated by git-cliff -->
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/MarcoIeni/release-plz/).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

2 participants