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

Added docs for externally supported entry points #1807

Merged
merged 6 commits into from
May 28, 2024

Conversation

oddbookworm
Copy link
Contributor

@oddbookworm oddbookworm commented May 20, 2024

Documenting external projects that have Briefcase entry points

Docs don't exist yet

N/A

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

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

I've flagged a simplification of the external hook definititions; I'll probably take a pass at editing the docs page as well.

@@ -378,6 +378,7 @@ def select_option(
default: str | None,
options: Sequence[str],
override_value: str | None,
external_hooks: str | None = None,
Copy link
Member

Choose a reason for hiding this comment

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

This doesn't need to be a configurable argument. An external hook is only needed for one specific template selection, so it would be better to put the extra content directly into the intro prompt.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I pushed a commit to remove this argument and put it directly into the intro. Let me know what you think of the new version

Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

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

I've done a bit of editing on the specific text (including a major addition around the plugin interface itself), but the original PR was a great starting point. Thanks for the PR!

@freakboy3742 freakboy3742 merged commit 25070c1 into beeware:main May 28, 2024
43 checks passed
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.

None yet

2 participants