Skip to content

Conversation

@ekouts
Copy link
Contributor

@ekouts ekouts commented Oct 19, 2021

Fixes #2215 .
I have added some description for completion_time and submit_time from the original issue. Should we add some documentation for other properties like name, workdir, max_pending_time, script_filename, stdout, stderr, sched_flex_alloc_nodes etc that currently don't appear in the reframe.core.schedulers.Job class?

@ekouts ekouts added this to the ReFrame sprint 21.10.1 milestone Oct 19, 2021
@ekouts ekouts requested review from teojgo and vkarak October 19, 2021 08:47
@ekouts ekouts self-assigned this Oct 19, 2021
@ekouts ekouts changed the title Document more of the existing Job properties [doc] Document more of the existing Job properties Oct 19, 2021
@codecov-commenter
Copy link

codecov-commenter commented Oct 19, 2021

Codecov Report

Merging #2227 (bdf1f6f) into master (8f37ff5) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2227   +/-   ##
=======================================
  Coverage   85.54%   85.54%           
=======================================
  Files          55       55           
  Lines        9746     9746           
=======================================
  Hits         8337     8337           
  Misses       1409     1409           
Impacted Files Coverage Δ
reframe/core/schedulers/__init__.py 98.36% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8f37ff5...bdf1f6f. Read the comment docs.

Copy link
Contributor

@vkarak vkarak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm. I don't think that we need to document the other properties that you mention, because these are also set at the test level, and it should be the preferred way to access them from there.

@vkarak vkarak merged commit 07c7182 into reframe-hpc:master Oct 20, 2021
@ekouts ekouts deleted the doc/document_job_properties branch October 25, 2021 07:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consider documenting more of the existing Job properties

3 participants