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

Add documentation for document type extension field #1771

Closed
rmartin16 opened this issue May 2, 2024 · 2 comments
Closed

Add documentation for document type extension field #1771

rmartin16 opened this issue May 2, 2024 · 2 comments
Labels
bug A crash or error in behavior. documentation An improvement required in the project's documentation.

Comments

@rmartin16
Copy link
Member

Describe the bug

When document types are configured for an app, the extension field is required but not documented.

For instance:

[tool.briefcase.app.podium.document_type.deck]
description = "Podium Slide Deck"
extension = "podium"
icon = "src/podium/resources/podium-deck"
url = 'https://beeware.org/project/projects/applications/podium/'

Steps to reproduce

See #1770 for example of what happens when extension isn't configured.

Expected behavior

The need and purpose of extension is documented.

The difference between this extension field and the extension specified in the name of the table isn't immediately clear...so, these differences may need to be understood to properly document this. Additionally, it's also possible one should be falling back to another in the code.

Screenshots

No response

Environment

  • Operating System: Sonoma
  • Python version: 3.12.2
  • Software versions:
    • Briefcase: 0.3.18.dev279+gdbe11cf0

Logs

See #1770.

Additional context

No response

@rmartin16 rmartin16 added bug A crash or error in behavior. documentation An improvement required in the project's documentation. labels May 2, 2024
@rmartin16 rmartin16 changed the title Add document for document type extension field Add documentation for document type extension field May 2, 2024
@freakboy3742
Copy link
Member

For anyone looking into this: https://github.com/beeware/podium is probably the only usage of this feature in practice; it's entirely possible the explicit extension attribute is an oversight, and it should be using the toml tag as the extension.

@AfiMaameDufie
Copy link
Contributor

Hi @freakboy3742 ,
I am looking into this now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug A crash or error in behavior. documentation An improvement required in the project's documentation.
Projects
None yet
Development

No branches or pull requests

3 participants