clone rubric added #455
clone rubric added #455
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the
WalkthroughA brief Grade Book grading instruction was expanded into a step-by-step grading workflow: two explicit grading methods (Student Assignment and Assignment Overview), detailed rubric handling including cloning, and multiple illustrative images with adjusted widths and point-allocation guidance. (≤50 words) Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
🤖 Fix all issues with AI agents
In `@source/instructors/authoring/assessments/grade-book.rst`:
- Around line 104-106: The image directive using
/img/guides/assignmentOverview.png currently has generic alt text "Assignment
Overview"; update this and the other occurrence(s) (also around lines showing
the same image) to unique, descriptive alt text that conveys the specific
content of each image (for example "Assignment overview showing grading summary
table" or "Assignment overview highlighting submission timeline"), by editing
the :alt: value in the image directives in grade-book.rst so each occurrence is
specific and distinct.
- Around line 59-61: Multiple image directives use the generic :alt: "Assignment
Overview", hurting accessibility; update each .. image::
/img/guides/assignmentOverview.png block (and the other two image blocks
referenced) to provide specific, descriptive alt text that communicates the
image content or purpose (e.g., "Assignment overview showing submission status
and grading summary", "Assignment overview highlighting rubric and due dates",
"Assignment overview with student attempt list and scores"); change the :alt:
value in each image directive accordingly so screen readers can distinguish
them.
- Line 59: Rename the image files and update their references to a consistent
lowercase-hyphen convention (e.g., change assignmentOverview.png ->
assignment-overview.png, Gradebooktesticon.png -> gradebook-test-icon.png,
gradebookgearicon.png -> gradebook-gear-icon.png) and update every documentation
reference (including the occurrences noted around lines with
assignmentOverview.png, Gradebooktesticon.png, gradebookgearicon.png and the
other listed locations) to use the new filenames; ensure file names on disk, any
build assets, and all .. image:: references in
source/instructors/authoring/assessments/grade-book.rst (and the other stated
occurrences) are updated and that links/paths remain correct.
- Line 46: The sentence "Click on the 0 or 1 to allocate initial points for
overall correctness and then use the other rubric items to subtract points for
missing items. There is also a **Points adjust** field if you wish to adjust
total points upwards." is duplicated in Method 1 and Method 2; consolidate by
creating a single shared note/admonition (e.g., an admonition titled "Scoring
tip" placed after the introductory section) and remove the duplicate sentences
from both Method 1 and Method 2, or alternatively replace them with a short
pointer like "See the Scoring tip above" in both places so the guidance is
maintained without exact duplication.
- Line 67: The document contains multiple consecutive blank lines in
source/instructors/authoring/assessments/grade-book.rst (notably around the
block at the former lines 67 and 74-78); remove extra empty lines so that normal
paragraphs have a single blank line between them and major section breaks have
at most two blank lines, ensuring no runs of 3+ blank lines remain and keeping
existing indentation and directive spacing intact; scan the file for other
repeated blank-line runs and normalize them consistently.
- Around line 51-53: There are three consecutive blank lines in grade-book.rst
that exceed reStructuredText conventions; edit the file to collapse any run of
three or more blank lines into a single blank line (or at most two where
visually needed between sections) so paragraphs and section breaks use one blank
line, then save the file.
- Around line 101-110: The "Clone from Assignment Overview" section duplicates
steps 1–3 from "Grade from Assignment Overview"; remove the repeated procedural
steps and images in the "Clone from Assignment Overview" block and insert an RST
cross-reference or internal link to the existing "Grade from Assignment
Overview" section (use the section title as the target) so the guide reuses that
canonical procedure, then renumber the subsequent steps in "Clone from
Assignment Overview" accordingly and ensure any image references
(assignmentOverview.png, Gradebooktesticon.png) are only kept in the original
section.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
source/instructors/authoring/assessments/grade-book.rst (3)
8-8: 🧹 Nitpick | 🔵 TrivialImprove sentence structure for clarity.
The sentence contains multiple independent clauses without proper conjunction. Add "and" before "it will not appear" or split into separate sentences for better readability.
📝 Proposed fix
-A Grade Book assessment may be used to manually grade assignments, it will not appear in the student guides. When the instructor opens a student assignment, the Grade Book is available for rubric based grading. +A Grade Book assessment may be used to manually grade assignments, and it will not appear in the student guides. When the instructor opens a student assignment, the Grade Book is available for rubric based grading.Alternatively, split into clearer sentences:
-A Grade Book assessment may be used to manually grade assignments, it will not appear in the student guides. When the instructor opens a student assignment, the Grade Book is available for rubric based grading. +A Grade Book assessment may be used to manually grade assignments. It will not appear in the student guides. When the instructor opens a student assignment, the Grade Book is available for rubric-based grading.
21-21: 🧹 Nitpick | 🔵 TrivialUse more formal documentation phrasing.
The phrase "must be toggled on" is slightly informal. Consider using "must be enabled" for consistency with standard documentation terminology.
📝 Proposed refinement
-- **Allow Partial Points** - Partial points must be toggled on for this type of assessment. Once you toggle this on, you will be able to add rubric items. +- **Allow Partial Points** - Partial points must be enabled for this type of assessment. Once you enable this option, you will be able to add rubric items.
25-25: 🧹 Nitpick | 🔵 TrivialConsider standardizing image widths for consistency.
Image widths vary throughout the document: 350px (line 25), 500px (line 53), and 450px (lines 70, 89, 102, 108). While not critical, standardizing these widths could improve visual consistency. Consider whether all inline images should use the same width or if different widths serve specific purposes.
Also applies to: 53-53, 70-70, 89-89, 102-102, 108-108
🤖 Fix all issues with AI agents
In `@source/instructors/authoring/assessments/grade-book.rst`:
- Line 66: Replace the generic alt attribute ":alt: Assignment Overview" used
for the images with concise, specific descriptive alt text that conveys each
image's actual content (e.g., describe layout, key labels, or purpose), updating
every occurrence (including the other instance of ":alt: Assignment Overview")
so each image has a unique, meaningful alt string rather than the generic
phrase.
- Line 92: The "yes" UI button label is currently bolded (**yes**) and should be
made consistent with your project's UI element style; replace **yes** with the
chosen style (e.g., "yes" or ``yes``) and apply the same change for the other
occurrence of the label (the second "yes" mention referenced in the comment);
search for the literal token yes used as a UI button in this document and update
all instances to match the selected convention.
- Around line 57-58: Replace the plain text step "Go to the assignment overview"
with a Sphinx cross-reference to the existing section used elsewhere ("Open the
student assignment") so navigation is consistent; locate the text "Go to the
assignment overview" in grade-book.rst and change it to reference the
appropriate target label (the section that covers opening the assignment
overview) using the project's established cross-reference style so both methods
use the same linked target.
2 participants
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.