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

Replace query-parameter spreadsheet with "ask the sim". #46

Open
pixelzoom opened this issue Aug 5, 2021 · 5 comments
Open

Replace query-parameter spreadsheet with "ask the sim". #46

pixelzoom opened this issue Aug 5, 2021 · 5 comments
Assignees

Comments

@pixelzoom
Copy link
Contributor

pixelzoom commented Aug 5, 2021

This came up at 8/5/21 dev meeting, and I volunteered to create this issue.

In Jauary 2021, @kathy-phet wanted a list of public query parameters supported by sims. So over in phetsims/tasks#1076, we populated @kathy-phet's 2021 PhET Sim: Query Parameter Review spreadsheet.

Problems with this spreadsheet:

  • It has been difficult to maintain because it's not in GitHub.
  • It's almost certainly out of sync with reality. Based on discussion at 8/5/21 dev meeting, developers have not been updating it, and some didn't know the spreadsheet existed.
  • Info in the spreadsheet may be wrong, and there's no way to check (not even with master branch of a sim.)
  • It does not tell you what query parameters are supported by a specific version of a sim.
  • It tells you nothing about a query parameter's type, valid values, default value, etc.

The proposal is to replace the spreadsheet with a query parameter that causes the sim to print its list of (public) query parameters to the console. All of my sims currently support something similar: with ?log, the full set of supported query parameters (public and internal) are printed to the console.

Questions for @kathy-phet:
(1) Are you OK with abandoning the spreadsheet and going with this new approach?
(2) Is it OK to just print query parameter names and their values? Or do we need to print more info, like type, valid values, doc, etc? The former is relatively easy, the latter will increase cost.
(3) What name would you like for this new query parameter? printPublicQueryParameters?

Assigning to @kathy-phet to reply to the above questions. Putting on the Developer project board for triage.

@zepumph
Copy link
Member

zepumph commented Aug 12, 2021

Today during status meeting @kathy-phet mentioned that she has noted this issue, and knows that it needs epic-level timing. @pixelzoom can you please note what (if anything) you would like to do in dev meeting before @kathy-phet has had a chance to take this on?

@zepumph
Copy link
Member

zepumph commented Aug 12, 2021

I also added a row for this issue in the overview spreadsheet, since it is an epic now.

@pixelzoom
Copy link
Contributor Author

There's no need for any development work until @kathy-phet responds to the above questions.

@zepumph
Copy link
Member

zepumph commented Oct 14, 2021

Today during quarterly planning, this was not marked as a quarterly goal for Q4 2021, so I'm going to move this to subgroups in dev meeting.

@samreid
Copy link
Member

samreid commented Sep 29, 2022

It's been over a year, and this issue is marked epic, so I don't think it also needs to be in the dev meeting subgroups. It will be managed an an epic at some quarterly planning.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants