Clarify simulator requirements

Open Beginner friendly
#87 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Find the documentation that describes simulator requirements and read the surrounding guidance first. Add an explicit statement that the simulator must be provided in a Python (.py) file, then check that the requirement is clear and consistent with the existing documentation.

Written by the indexing model from the issue text.

Description

documentation

There is no documentation stating the simulator has to be in a py file - make this explicit.

Dominant language
Jupyter Notebook
Stars
3
Forks
3
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from deepskies/DeepDiagnostics

All issues in deepskies/DeepDiagnostics

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.