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: disallow missing docs on crate level and allow where necessary #222

Merged
merged 7 commits into from
Sep 26, 2024

Conversation

CommanderStorm
Copy link
Contributor

@CommanderStorm CommanderStorm commented Sep 25, 2024

This PR is more for discussion which of these two approches you would like to prefer:

  • deny missing docs now, work on the allows for a while
  • work on the allows for a while, deny missing docs later

the advantage of denying now is that regressions (new modules being added without docs) is not possible anymore.

For example, 98429e4 would have been caught in #218 ^^

@CommanderStorm
Copy link
Contributor Author

Okay, lint-reasons were only stabilised in 1.81 (not 1.75)
=> they cannot be used.

Will switch to comments

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.

Thank you! ❤️
I find this reasonable - we can cover step by step removing allows. But we must enforce it for new changes

@DDtKey DDtKey changed the title docs: add a lint to not have missing docs and allow(missing_docs) where nessesary docs: disallow missing docs on crate level and allow where necessary Sep 26, 2024
@DDtKey DDtKey merged commit 149062c into testcontainers:main Sep 26, 2024
6 checks passed
@CommanderStorm CommanderStorm deleted the no-missing-docs branch September 26, 2024 09:52
@github-actions github-actions bot mentioned this pull request Sep 26, 2024
DDtKey pushed a commit that referenced this pull request Sep 26, 2024
## 🤖 New release
* `testcontainers-modules`: 0.11.0 -> 0.11.1 (✓ API compatible changes)

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

<blockquote>

## [0.11.1] - 2024-09-26

### Documentation

- Disallow missing docs on crate level and allow where necessary
([#222](#222))

### Features

- Implement `with_init_sql` for `Postgres`, `Mysql` and `Mariadb`
([#182](#182))
- Tls certs and ldif file
([#217](#217))

<!-- 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