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

Documentation: Remove defaulting to "John Does" as airframe maintainer #24203

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MaEtUgR
Copy link
Member

@MaEtUgR MaEtUgR commented Jan 13, 2025

Solved Problem

When looking at airframe documentation @RomanBapst found that it's ridiculous to have "John Doe" as maintainer for many airframes. It's just a mock person and the information doesn't add any value but just clutter the documentation and possibly even cause confusion.

Solution

Remove the default string for the maintainer defined in the airframe parsing script. If no maintainer is defined then no maintainer should be added.

Changelog Entry

Documentation: Remove defaulting to "John Does" as airframe maintainer

Alternatives

We could also fail the parsing when no maintainer is defined but in my eyes that's too strict and gets into people's way.

Test coverage

It still parses and builds, we need to check that None actually causes the behavior we want or if it needs to be an empty string.

Context

@MaEtUgR MaEtUgR self-assigned this Jan 13, 2025
@MaEtUgR MaEtUgR requested a review from RomanBapst January 13, 2025 08:58
@sfuhrer
Copy link
Contributor

sfuhrer commented Jan 14, 2025

Agree with the functional change - the CI failures look rather real though, somewhere maintainer = None seems to cause issues.

@dagar dagar marked this pull request as draft January 22, 2025 16:27
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