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.

Sign up for GitHub

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

Jump to bottom

📝 Documentation: Mention Base Options parsing in producer and runner API docs #80

Open
2 tasks done
JoshuaKGoldberg opened this issue Dec 20, 2024 · 0 comments
Open
2 tasks done

📝 Documentation: Mention Base Options parsing in producer and runner API docs #80

JoshuaKGoldberg opened this issue Dec 20, 2024 · 0 comments
Assignees
@JoshuaKGoldberg
Labels
area: documentation Improvements or additions to documentation ("docs") status: accepting prs Please, send a pull request to resolve this! 🙏
Milestone
Blocks Launch

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

Overview

In #72 I removed the behavior of filling in Base Options defaults from producer and runner APIs. No more optionsAugment or await produceBase(preset.base). The APIs now are much more straightforward and require passing in options altogether.

runCLI -> runModeInitialize (as of #72) is now what does the nice logic of running Base options parsing and then prompting the running user for any missing required ones.

I think the docs should suggest in the producer and/or runner APIs how to get Base Options read in.

Additional Info

💖
@JoshuaKGoldberg JoshuaKGoldberg added area: documentation Improvements or additions to documentation ("docs") status: accepting prs Please, send a pull request to resolve this! 🙏 labels Dec 20, 2024
@JoshuaKGoldberg JoshuaKGoldberg added this to the Blocks Launch milestone Dec 20, 2024
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Dec 20, 2024
@JoshuaKGoldberg JoshuaKGoldberg changed the title 📝 Documentation: <short description of the request> 📝 Documentation: Mention Base Options parsing in docs Dec 20, 2024
@JoshuaKGoldberg JoshuaKGoldberg changed the title 📝 Documentation: Mention Base Options parsing in docs 📝 Documentation: Mention Base Options parsing in producer and runner API docs Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
area: documentation Improvements or additions to documentation ("docs") status: accepting prs Please, send a pull request to resolve this! 🙏
Projects
None yet
Milestone
Blocks Launch
Development

No branches or pull requests
1 participant
@JoshuaKGoldberg