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

Clarified docs and fixed typo #29

Merged
merged 4 commits into from
Feb 4, 2025
Merged

Clarified docs and fixed typo #29

merged 4 commits into from
Feb 4, 2025

Conversation

Linardos
Copy link
Contributor

@Linardos Linardos commented Feb 4, 2025

Proposed Changes

  • Typo fixed and explanations on foggy details added

Checklist

  • Tests have been run (pytest --cov=. --cov-report=xml) and the result (coverage report -m) has been pasted here for reviewers.
  • CONTRIBUTING guide has been followed.
  • PR is based on the current GaNDLF-Synth main branch.
  • Non-breaking change (does not break existing functionality): provide as many details as possible for any breaking change.
  • Function/class source code documentation added/updated (ensure typing is used to provide type hints, including and not limited to using Optional if a variable has a pre-defined value).
  • Code has been blacked for style consistency and linting.
  • [] If applicable, version information has been updated in GANDLF/version.py.
  • [] If adding a git submodule, add to list of exceptions for black styling in pyproject.toml file.
  • Usage documentation has been updated, if appropriate.
  • [] If customized dependency installation is required (i.e., a separate pip install step is needed for PR to be functional), please ensure it is reflected in all the files that control the CI, namely: python-test.yml.

@Linardos Linardos requested a review from a team as a code owner February 4, 2025 15:14
Copy link
Contributor

github-actions bot commented Feb 4, 2025

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

docs/customize.md Outdated Show resolved Hide resolved
@sarthakpati sarthakpati merged commit 89c660a into mlcommons:main Feb 4, 2025
8 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Feb 4, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants