adding docstring #2236
Merged
adding docstring #2236
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## create-maestro-platform#2165 #2236 +/- ##
================================================================
- Coverage 52.75% 52.62% -0.14%
================================================================
Files 72 73 +1
Lines 17614 17634 +20
Branches 3418 3418
================================================================
- Hits 9293 9280 -13
- Misses 7480 7559 +79
+ Partials 841 795 -46
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Make it a draft? |
VindeeR
added
documentation
|
@isimo00 I've implemented many changes and lint fixes to the files, I too add Documentation to all function but I doubt they are perfectly explained so, I would like to ask if you could do a double check and raise any and all issues you find with the changes so we can improve the documentation/understanding of the behavior |
|
Will do tomorrow, thanks @VindeeR :) |
isimo00
approved these changes
Mar 20, 2025
| if not duplicated_jobs_already_checked: | ||
| job_name = package.name if hasattr(package, "name") else package.jobs[0].name | ||
| jobid = self.get_jobid_by_jobname(job_name) | ||
| if len(jobid) > 1: # Cancel each job that is not the associated | ||
| ids_to_check = [package.jobs[0].id] | ||
| if package.jobs[0].het: | ||
| for i in range(1,package.jobs[0].het.get("HETSIZE",1)): | ||
| for i in range(1,package.jobs[0].het.get("HETSIZE",1)): # noqa |
There was a problem hiding this comment.
# noqa is a way to ignore errors in linters based in Flake8 and Pep8
So I'm technically ignoring any and all errors in this line, but the idea was just to ignore the HETSIZE since linters identify it as a misspelled word
There was a problem hiding this comment.
I think the word comes from no quality assurance, as normally linters and other static analyzers would be grouped as quality assurance tools (but a random guess).
isimo00
pushed a commit
that referenced
this pull request
Mar 31, 2025
Ini docstring fixing SlurmPlatform docstring Add some descriptions (testing) Add skeleton of Maestro platform class adding docstring (#2236) * adding docstring * import failling CI/CD * docstring slurmplatform * linting + docstring Fix exit code in autosubmit commands that return bool 4.1.12 recovery is slow (#2237) * Changelog * WIP DROPME Use a dev version of config parser * WIP DROPME Use a dev version of config parser * rebse * update asconfigparser version * removed update_parameters call --------- Co-authored-by: Bruno P. Kinoshita <[email protected]> specify python version and update command line 4.1.12 release branch (#2042) * Changelog * WIP DROPME Use a dev version of config parser * WIP DROPME Use a dev version of config parser * rebse * update asconfigparser version * 4.1.12 recovery is slow (#2237) * Changelog * WIP DROPME Use a dev version of config parser * WIP DROPME Use a dev version of config parser * rebse * update asconfigparser version * removed update_parameters call --------- Co-authored-by: Bruno P. Kinoshita <[email protected]> * WIP DROPME Use a dev version of config parser * WIP DROPME Use a dev version of config parser * rebse * changelog added * changelog added --------- Co-authored-by: Bruno P. Kinoshita <[email protected]> Add documentation about workflow commit, fix make watch update eb recipe (#2243) Update setuptools requirement from <=76.0.0 to <=77.0.3 Updates the requirements on [setuptools](https://github.com/pypa/setuptools) to permit the latest version. - [Release notes](https://github.com/pypa/setuptools/releases) - [Changelog](https://github.com/pypa/setuptools/blob/main/NEWS.rst) - [Commits](pypa/setuptools@0.6...v77.0.3) --- updated-dependencies: - dependency-name: setuptools dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Update setuptools requirement from <=77.0.3 to <=78.0.2 Updates the requirements on [setuptools](https://github.com/pypa/setuptools) to permit the latest version. - [Release notes](https://github.com/pypa/setuptools/releases) - [Changelog](https://github.com/pypa/setuptools/blob/main/NEWS.rst) - [Commits](pypa/setuptools@0.6...v78.0.2) --- updated-dependencies: - dependency-name: setuptools dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Use pytestify to convert unittests to pytest Clean unused code Adding slurm_monitor and strategies tests, deleting unused function in slurm_monitor (see BSC-ES/autosubmit-api#175) Add Docker marker, update CONTRIBUTING docs with information for contributors to run integration+docker tests Update portalocker requirement from <=2.7.0 to <=3.1.1 Updates the requirements on [portalocker](https://github.com/wolph/portalocker) to permit the latest version. - [Release notes](https://github.com/wolph/portalocker/releases) - [Changelog](https://github.com/wolph/portalocker/blob/develop/CHANGELOG.rst) - [Commits](wolph/portalocker@v0.5.6...v3.1.1) --- updated-dependencies: - dependency-name: portalocker dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Add DbManager factory function (#2107) * add DbManager factory function * add extra typings * Update autosubmit/job/job_list_persistence.py Co-authored-by: Luiggi Tenorio <[email protected]> --------- Co-authored-by: Bruno P. Kinoshita <[email protected]> verify args to format message (#2113) Documentation improvement maestro (#2247) * fixing some minor documentation problems and removing verbosity that would cause confusion * fixing sphinx identation problem * Creating a step-by-step of slurm tests + reaorganizing existing documentation * refining test * removing file that shouldnt be there * removing duplicated parameters simplifying description and proportions * adjusting docstring of the function improving quality of documentation bettering wording of instruction and giving hints changes to platform to simulate different behaviours between slurm and maestro Change file name Update job.py revert Update ecplatform.py revert Update paramiko_submitter.py revert removing unused imports fixing instructions Fix sphyinx local build and example_platform name change Small fixes adjusting configure platform draft of a extending platform Add some references extra information where might be needed changes Clean Configure Experiments page small fixes document Move autosubmit create syntax doc Move autosubmit create docs Rewrite some snippets Add permalinks and formatting
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.