Conversation
WalkthroughConsolidates and streamlines multiple instructor assessment docs: collapses separate General/Metadata/Files creation steps into shorter flows, adds AI-generation cross-references, standardizes image/heading/LaTeX formatting, renames/reorders some grader sections, and expands partial-points examples with JS/Python snippets. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Possibly related PRs
Suggested reviewers
Pre-merge checks❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
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[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 10
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/partial-points.rst (2)
30-30: Improve sentence clarity regarding Mocha invocation.The sentence structure is awkward and mixes description with implementation details. Break it into clearer parts:
-The Python script parses the student's file and then assigns points based on specific criteria. In the JavaScript version, it uses Unit Testing through Mocha, a popular `node` library and it is invoked with ``mocha 2>&1 || true`` to force the exit code to be 0. +The Python script parses the student's file and assigns points based on specific criteria. The JavaScript version uses Mocha (a popular Node.js testing library) for unit testing, invoked with ``mocha 2>&1 || true`` to ensure an exit code of 0.
148-150: Resolve inconsistent guidance in the "important" admonition.Line 148–150 states the score should be "between 0 and the maximum score you specified," but the API specification in Line 17 explicitly requires a 0–100 percentage. Align the admonition with the V2 API guidance:
-.. important:: - The score you award should be any value between 0 and the maximum score you specified when defining the assessment in the Codio authoring editor. +.. important:: + When using the V2 API, the **Score** parameter must be a percentage between 0 and 100. This will be normalized to your assessment's total points.source/instructors/authoring/assessments/parsons-puzzle.rst (1)
93-109: Clarify the "can/must" phrasing in variable test object description.Line 95 uses "can/must have" which is ambiguous and informal. The intent appears to be that some properties are optional and some are required, but this is unclear. The list that follows indicates which are required via inline notation.
Revise to make this clearer:
- Each variable test object can/must have the following properties: + Each variable test object may have the following properties (required properties noted):Alternatively, consider separating required and optional properties into distinct sections for improved clarity.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (4)
source/img/guides/assessment_gb_rubric.pngis excluded by!**/*.png,!**/*.pngsource/img/guides/assessment_mc_exec.pngis excluded by!**/*.png,!**/*.pngsource/img/guides/assessment_mc_grading.pngis excluded by!**/*.png,!**/*.pngsource/img/guides/parsonspuzzlegrading.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (5)
source/instructors/authoring/assessments/grade-book.rst(1 hunks)source/instructors/authoring/assessments/math-assessments.rst(1 hunks)source/instructors/authoring/assessments/multiple-choice.rst(1 hunks)source/instructors/authoring/assessments/parsons-puzzle.rst(2 hunks)source/instructors/authoring/assessments/partial-points.rst(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rst
⚙️ CodeRabbit configuration file
**/*.rst: Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Clear and concise language.
- Correct grammar and spelling.
- Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
- Adherence to style guides (e.g., consistent tone, terminology).
Suggest improvements to enhance readability and accessibility.- Make sure to find all improvements on the first pass.
Go through the material multiple times before submitting comments.
Files:
source/instructors/authoring/assessments/math-assessments.rstsource/instructors/authoring/assessments/partial-points.rstsource/instructors/authoring/assessments/grade-book.rstsource/instructors/authoring/assessments/multiple-choice.rstsource/instructors/authoring/assessments/parsons-puzzle.rst
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
source/instructors/authoring/assessments/partial-points.rst (1)
28-30: Improve sentence structure and grammar in the introduction to examples.Line 30 contains a run-on construction. Split and clarify the relationship between languages and execution methods:
-The Python script parses the student's file and then assigns points based on specific criteria. In the JavaScript version, it uses Unit Testing through Mocha, a popular `node` library and it is invoked with ``mocha 2>&1 || true`` to force the exit code to be 0. +The Python script parses the student's file and assigns points based on specific criteria. The JavaScript version uses Unit Testing through Mocha, a popular Node.js library, invoked with ``mocha 2>&1 || true`` to ensure the exit code is 0.
♻️ Duplicate comments (4)
source/instructors/authoring/assessments/parsons-puzzle.rst (2)
61-68: Correct action verb capitalization inconsistency in Grading section.Line 63 uses lowercase "enable," while line 64 and 67 use capitalized "Toggle." Standardize verb capitalization for consistency:
- **Define Number of Attempts** - Enable to allow and set the number of attempts students can make for this assessment. If disabled, the student can make unlimited attempts. + **Define Number of Attempts** - Enable to allow and set the number of attempts students can make for this assessment. If disabled, students can make unlimited attempts.Also, consider rewording for clarity:
+ **Define Number of Attempts** - Toggle to enable attempt limits and specify the maximum number of attempts. If disabled, students can make unlimited attempts.This provides consistency with the "Toggle" verb used in lines 64 and 67 while improving clarity.
131-137: Correct RST directive capitalization.Line 136 uses an uppercase 'N' in the note directive (
.. Note::), which violates RST conventions. Correct to lowercase:-.. Note:: Student code should use the variable ``myTurtle`` for commands to control the turtle in order for the grading to work. +.. note:: Student code should use the variable ``myTurtle`` for commands to control the turtle in order for the grading to work.source/instructors/authoring/assessments/multiple-choice.rst (1)
51-65: Standardize parameter description punctuation and clarity.Line 53 ("Incorrect Points") has inconsistent formatting and an incomplete ending. Align it with the style of "Correct Points" (line 51) and other parameters for consistency:
- **Incorrect Points** - The score to be deducted if the student makes an incorrect selection. Typically, this value will be 0 but you can assign any positive numeric value if you wish to penalize guessing. If this assessment is to be ungraded, set '0' points + **Incorrect Points** - The score deducted for an incorrect selection. Typically 0; you can assign a positive numeric value to penalize guessing. For ungraded assessments, enter 0.Also note: Line 61 appears to have been improved since the past review comment; current phrasing "Toggle to enable attempt limits and specify the maximum number of attempts" is clear and consistent.
source/instructors/authoring/assessments/math-assessments.rst (1)
16-20: Standardize LaTeX capitalization for consistency (line 18).Line 18 uses "LaTex" with inconsistent capitalization. Correct to "LaTeX" to align with the cross-reference on line 16 and the usage throughout the file (lines 20, 25):
-You can enter LaTex in the **Question** and **Rationale** fields. +You can enter LaTeX in the **Question** and **Rationale** fields.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (5)
source/instructors/authoring/assessments/grade-book.rst(1 hunks)source/instructors/authoring/assessments/math-assessments.rst(1 hunks)source/instructors/authoring/assessments/multiple-choice.rst(1 hunks)source/instructors/authoring/assessments/parsons-puzzle.rst(2 hunks)source/instructors/authoring/assessments/partial-points.rst(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rst
⚙️ CodeRabbit configuration file
**/*.rst: Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Clear and concise language.
- Correct grammar and spelling.
- Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
- Adherence to style guides (e.g., consistent tone, terminology).
Suggest improvements to enhance readability and accessibility.- Make sure to find all improvements on the first pass.
Go through the material multiple times before submitting comments.
Files:
source/instructors/authoring/assessments/math-assessments.rstsource/instructors/authoring/assessments/multiple-choice.rstsource/instructors/authoring/assessments/parsons-puzzle.rstsource/instructors/authoring/assessments/partial-points.rstsource/instructors/authoring/assessments/grade-book.rst
🧠 Learnings (1)
📚 Learning: 2025-10-27T17:55:37.142Z
Learnt from: LolaValente
Repo: codio/knowledge PR: 426
File: source/instructors/authoring/assessments/llm-based-rubric.rst:61-61
Timestamp: 2025-10-27T17:55:37.142Z
Learning: In rst files for the Codio knowledge repository, image directive attributes (`:height:`, `:alt:`, etc.) should be indented with 3 spaces, not 4. Content following an image directive should not be indented unless it's intentionally part of that directive.
Applied to files:
source/instructors/authoring/assessments/grade-book.rst
🔇 Additional comments (2)
source/instructors/authoring/assessments/multiple-choice.rst (1)
34-49: Verify image width attribute formatting is consistent.Lines 38 and 49 both specify
:width: 450pxfor images. Confirm the indentation uses 3 spaces (not 4) from the.. image::line, per RST best practices in this repository:.. image:: /img/guides/assessment_mc_exec.png :alt: Execution :width: 450pxThis appears correct in the provided code. Ensure it remains consistent across all image directives in the file.
source/instructors/authoring/assessments/grade-book.rst (1)
25-30: Improve phrasing in the Name parameter description (line 30).The phrase "the name in the challenge text the student sees" is grammatically awkward and unclear. Reword for clarity:
- **Name** - Enter a short name that describes the test. This name is displayed in the teacher dashboard so the name should reflect the challenge and thereby be clear when reviewing. If you want to hide the name in the challenge text the student sees, toggle the **Show Name** setting to disable it. + **Name** - Enter a short name that describes the test. This name appears in the teacher dashboard for easy reference. To hide the name from the student's view of the challenge, toggle **Show Name** to disable it.This revision clarifies the relationship between the name display and the Show Name setting.
Likely an incorrect or invalid review comment.
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
source/instructors/authoring/assessments/multiple-choice.rst(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rst
⚙️ CodeRabbit configuration file
**/*.rst: Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Clear and concise language.
- Correct grammar and spelling.
- Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
- Adherence to style guides (e.g., consistent tone, terminology).
Suggest improvements to enhance readability and accessibility.- Make sure to find all improvements on the first pass.
Go through the material multiple times before submitting comments.
Files:
source/instructors/authoring/assessments/multiple-choice.rst
shajason
left a comment
shajason
left a comment
There was a problem hiding this comment.
Let's standardize on the text about finding information about General, Metadata and Files for all the assessments. Also, if you agree, let's remove the Files and Metadata portions on all these pages.
I didn't look at the CR comments at all - I will leave those to you.
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
source/instructors/authoring/assessments/advanced-code-test.rst (1)
44-44: Capitalize initial action verb in Define Number of Attempts.Line 44 starts with "enable" (lowercase). For consistency with standard parameter description formatting (as seen in other assessment files), this should be capitalized:
- **Define Number of Attempts** - enable to allow and set the number of attempts students can make for this assessment. If disabled, the student can make unlimited attempts. + **Define Number of Attempts** - Enable to allow and set the number of attempts students can make for this assessment. If disabled, the student can make unlimited attempts.
♻️ Duplicate comments (2)
source/instructors/authoring/assessments/parsons-puzzle.rst (1)
60-60: Capitalize initial action verb in Define Number of Attempts.Line 60 starts with "enable" (lowercase), which is inconsistent with the capitalization pattern in similar parameter descriptions. For consistency with bullet-point formatting conventions, this should be capitalized:
- **Define Number of Attempts** - enable to allow and set the number of attempts students can make for this assessment. If disabled, the student can make unlimited attempts. + **Define Number of Attempts** - Enable to allow and set the number of attempts students can make for this assessment. If disabled, the student can make unlimited attempts.source/instructors/authoring/assessments/partial-points.rst (1)
17-19: Fix parameter descriptions for clarity and consistency.The parameter descriptions have several inconsistencies that should be addressed:
- Line 17: The parenthetical
(``CODIO_PARTIAL_POINTS_V2_URL``)is confusing—this is the environment variable name, not a descriptor for the Score parameter. The URL reference belongs in the introductory context (line 14), not here.- Line 18: Use
MBinstead ofMbfor consistency with standard abbreviations.- General formatting: Standardize parameter descriptions to use consistent capitalization and punctuation.
Apply this diff:
- **Score** (``CODIO_PARTIAL_POINTS_V2_URL``) - a percentage of total points possible between 0-100. - **Feedback** - text - this is limited to 1 Mb - **Format** - html, md, or txt (default) + **Score** - A percentage of total points possible, ranging from 0–100. + **Feedback** - Text input, limited to 1 MB. + **Format** - HTML, Markdown, or plaintext (default: plaintext).
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (7)
source/instructors/authoring/assessments/advanced-code-test.rst(3 hunks)source/instructors/authoring/assessments/fill-in-blanks.rst(1 hunks)source/instructors/authoring/assessments/free-text.rst(1 hunks)source/instructors/authoring/assessments/grade-book.rst(1 hunks)source/instructors/authoring/assessments/multiple-choice.rst(1 hunks)source/instructors/authoring/assessments/parsons-puzzle.rst(2 hunks)source/instructors/authoring/assessments/partial-points.rst(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rst
⚙️ CodeRabbit configuration file
**/*.rst: Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Clear and concise language.
- Correct grammar and spelling.
- Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
- Adherence to style guides (e.g., consistent tone, terminology).
Suggest improvements to enhance readability and accessibility.- Make sure to find all improvements on the first pass.
Go through the material multiple times before submitting comments.
Files:
source/instructors/authoring/assessments/advanced-code-test.rstsource/instructors/authoring/assessments/multiple-choice.rstsource/instructors/authoring/assessments/parsons-puzzle.rstsource/instructors/authoring/assessments/grade-book.rstsource/instructors/authoring/assessments/fill-in-blanks.rstsource/instructors/authoring/assessments/partial-points.rstsource/instructors/authoring/assessments/free-text.rst
🧠 Learnings (1)
📚 Learning: 2025-10-27T17:55:37.142Z
Learnt from: LolaValente
Repo: codio/knowledge PR: 426
File: source/instructors/authoring/assessments/llm-based-rubric.rst:61-61
Timestamp: 2025-10-27T17:55:37.142Z
Learning: In rst files for the Codio knowledge repository, image directive attributes (`:height:`, `:alt:`, etc.) should be indented with 3 spaces, not 4. Content following an image directive should not be indented unless it's intentionally part of that directive.
Applied to files:
source/instructors/authoring/assessments/grade-book.rst
🔇 Additional comments (8)
source/instructors/authoring/assessments/grade-book.rst (1)
16-17: Verify image directive indentation follows 3-space convention.Per established RST conventions in this repository, image directive attributes should be indented with 3 spaces, not 4. Check the indentation of
:alt:and:width:attributes on these image blocks to ensure consistency.As per learnings, please verify the indentation alignment of image attributes throughout this file matches the 3-space standard established in previous reviews.
Also applies to: 36-37, 41-42
source/instructors/authoring/assessments/free-text.rst (1)
54-54: Step numbering alignment.Line 54 shows "3. Click Create" but the manual creation flow only shows 2 prior main steps (lines 22 and 24). This should be step 3, which is correct. However, verify this aligns with the actual content structure shown in the file (2 numbered steps before Create).
source/instructors/authoring/assessments/partial-points.rst (1)
25-25: Standardize section heading title capitalization.Verify that section heading capitalization is consistent across the file:
- Line 12: "Autograding Enhancements for Partial Points" (title case)
- Line 25: "Example Auto-Grading Scripts With Partial Points" (title case with hyphen)
- Line 116: "Example Grading Script for Partial Points" (title case)
All three appear to follow title case, which is good. However, line 25 includes a hyphenated term "Auto-Grading"—verify this matches intended style.
Also applies to: 116-116
source/instructors/authoring/assessments/multiple-choice.rst (3)
49-49: Verify Incorrect Points description is grammatically correct and consistent.Line 49 reads: "The score to be deducted if the student makes an incorrect selection. Typically, this value will be 0, but you can assign any positive numeric value if you wish to penalize guessing. If this assessment is to be ungraded, enter zero (0)."
This appears to address past review comments (comma after "will be 0" and "zero (0)" notation). However, verify the phrasing is final and consistent. The phrase "this assessment is to be ungraded" is slightly awkward; consider "If this is an ungraded assessment" for consistency with line 47 ("If this is an ungraded assessment").
57-57: Verify Define Number of Attempts phrasing is clear.Line 57 reads: "Toggle to enable attempt limits and specify the maximum number of attempts. If disabled, students can make unlimited attempts."
This appears to address past concerns about awkward phrasing ("enable to allow and set"). The current version is clearer. Verify this matches the intended improvement noted in past reviews.
59-59: Verify Show Rationale options are complete and consistently formatted.Line 59 lists options:
**Never**, **After x attempts**, **If score is greater than or equal to a % of the total**, **When grades are released**, or **Always**.Past comments noted that "when grades are released" is a new option. Verify this list is now complete and properly formatted with Oxford comma before "or Always". The current formatting appears correct with the Oxford comma.
source/instructors/authoring/assessments/parsons-puzzle.rst (1)
129-129: Verify RST directive capitalization.Line 129 shows
.. note::which is correct—RST directives should be lowercase. This is consistent with file conventions and past feedback noting that uppercase.. Note::would be incorrect.source/instructors/authoring/assessments/advanced-code-test.rst (1)
45-45: Fix grammar and formatting issues; verify consistency of "When grades are released" option.The review identifies three definitive issues with line 45:
- Grammar: "selecting" should be "by selecting" (confirmed; this error appears in multiple assessment files: parsons-puzzle, standard-code-test, and autograde-free-text)
- Oxford comma: Missing before "or Always" (confirmed; multiple-choice.rst correctly includes this)
- Terminal period: Missing (confirmed; multiple-choice.rst includes it)
Regarding the "When grades are released" option: it appears only in multiple-choice.rst and is absent from all code-based assessments (advanced-code-test, standard-code-test, autograde-free-text, parsons-puzzle). This could reflect intentional product design (grading workflow differences) or a documentation gap requiring consistency. Verify whether this option applies to code-based assessments before including it in the fix.
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
source/instructors/authoring/assessments/advanced-code-test.rst (1)
60-60: Break this sentence for improved readability.This sentence is lengthy and contains multiple clauses. Consider splitting it into two sentences for better clarity and easier scanning.
-Additionally, Codio pre-populates a project in **My Projects** called **Demo Guides and Assessments** that contains examples for all assessment types and a guides authoring cheat sheet. If you do not see this project, go to **Starter Packs** and search for **Demo Guides and Assessments**. Click **Use Pack** and then **Create** to make a copy in your **My Projects** area. +Additionally, Codio pre-populates a project in **My Projects** called **Demo Guides and Assessments**. This project contains examples for all assessment types and a guides authoring cheat sheet. + +If you do not see this project, go to **Starter Packs** and search for **Demo Guides and Assessments**. Click **Use Pack** and then **Create** to make a copy in your **My Projects** area.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
source/instructors/authoring/assessments/advanced-code-test.rst(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rst
⚙️ CodeRabbit configuration file
**/*.rst: Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Clear and concise language.
- Correct grammar and spelling.
- Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
- Adherence to style guides (e.g., consistent tone, terminology).
Suggest improvements to enhance readability and accessibility.- Make sure to find all improvements on the first pass.
Go through the material multiple times before submitting comments.
Files:
source/instructors/authoring/assessments/advanced-code-test.rst
🔇 Additional comments (3)
source/instructors/authoring/assessments/advanced-code-test.rst (3)
36-49: Grading section reorganization is well-structured.The consolidated workflow (step 3 with image and inline bullet points leading to step 4) flows logically. The image placement is appropriate, and the transition from configuration details to the final action is clear. RST formatting for the image directive is correct.
13-13: Note directives use consistent inline format.Both
.. note::statements properly use RST inline notation with lowercase directives, maintaining consistency throughout the document. Formatting is correct.Also applies to: 30-30
24-28: All internal cross-references are properly linked.Language type references (lines 24–28) correctly link to their corresponding test type sections. The
:ref:syntax for cross-file references is properly formatted, and all anchor labels are defined. No broken links detected.Also applies to: 63-212
source/instructors/authoring/assessments/advanced-code-test.rst
Outdated
Show resolved
Hide resolved
shajason
left a comment
shajason
left a comment
There was a problem hiding this comment.
I'm sure it's super annoying but more little things...
source/instructors/authoring/assessments/advanced-code-test.rst
Outdated
Show resolved
Hide resolved
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 (1)
source/instructors/authoring/assessments/grade-book.rst (1)
1-43: Fix inconsistent spacing in the introductory paragraph and verify content consistency.Line 8 contains extra spaces around parenthetical references. Additionally, verify that this file's intro format aligns with the pattern used in other assessment type files:
- 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. Comments, points, and rubric items are visible to the student when the assessment is graded and the grades are released. Grade Book assessments do not show in the total assessment count on student/teacher dashboard. For more information on **General**, **Metadata** (optional) and **Files** (optional) see :ref:`Assessments <assessments>`. + 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. Comments, points, and rubric items are visible to the student when the assessment is graded and the grades are released. Grade Book assessments do not show in the total assessment count on the student/teacher dashboard. For more information on **General**, **Metadata** (optional) and **Files** (optional) see :ref:`Assessments <assessments>`.Note: Also fixed comma splice ("assignments, it will not appear" → "assignments; it will not appear") and standardized spacing (double spaces reduced to single).
♻️ Duplicate comments (4)
source/instructors/authoring/assessments/advanced-code-test.rst (2)
16-16: Add missing comma before "see" for clarity.The sentence reads ambiguously without proper punctuation. A comma is needed before "see" to separate the introductory phrase from the reference.
-For more information on **General**, **Metadata** and **Files** see :ref:`Assessments <assessments>`. +For more information on **General**, **Metadata** and **Files**, see :ref:`Assessments <assessments>`.
45-45: Fix grammar by adding "by" for clarity.The phrasing "set when to show this selecting from" is grammatically awkward. Add "by" to make it correct.
-You can set when to show this selecting from **Never**, **After x attempts**, **If score is greater than or equal to a % of the total** or **Always** +You can set when to show this by selecting from **Never**, **After x attempts**, **If score is greater than or equal to a % of the total** or **Always**source/instructors/authoring/assessments/parsons-puzzle.rst (2)
61-61: Unresolved: "Show Rationale to Students" description needs grammatical and structural fixes.This item still contains issues flagged in previous review:
- Redundancy: "display the answer, and the rationale for the answer, to the student" is repetitive.
- Missing preposition: "set when to show this selecting" should be "set when to show this by selecting."
- Missing Oxford comma before "or Always."
- Missing terminal period at the end.
- **Show Rationale to Students** - Toggle to display the answer, and the rationale for the answer, to the student. This guidance information will be shown to students after they have submitted their answer and any time they view the assignment after marking it as completed. You can set when to show this selecting from **Never**, **After x attempts**, **If score is greater than or equal to a % of the total** or **Always** + **Show Rationale to Students** - Toggle to display the rationale for the answer. This guidance information will be shown to students after they have submitted their answer and any time they view the assignment after marking it as completed. You can set when to show this by selecting from **Never**, **After x attempts**, **If score is greater than or equal to a % of the total**, or **Always**.
63-63: Restructure dense Rationale field description for clarity.The Rationale description remains a long, complex sentence that conflates multiple distinct concepts (what to enter, teacher visibility, student visibility). Break it into shorter, more digestible parts:
- **Rationale** - Enter guidance for the assessment. This is visible to the teacher when the project is opened in the course or when opening the student's project. This guidance information can also be shown to students after they have submitted their answer and when they reload the assignment after marking it as completed. + **Rationale** - Enter guidance for the assessment. This is always visible to teachers when viewing the project. It can also be shown to students after submission and when they reload the assignment after marking it as completed.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
source/instructors/authoring/assessments/advanced-code-test.rst(2 hunks)source/instructors/authoring/assessments/grade-book.rst(1 hunks)source/instructors/authoring/assessments/multiple-choice.rst(1 hunks)source/instructors/authoring/assessments/parsons-puzzle.rst(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rst
⚙️ CodeRabbit configuration file
**/*.rst: Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Clear and concise language.
- Correct grammar and spelling.
- Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
- Adherence to style guides (e.g., consistent tone, terminology).
Suggest improvements to enhance readability and accessibility.- Make sure to find all improvements on the first pass.
Go through the material multiple times before submitting comments.
Files:
source/instructors/authoring/assessments/grade-book.rstsource/instructors/authoring/assessments/parsons-puzzle.rstsource/instructors/authoring/assessments/advanced-code-test.rstsource/instructors/authoring/assessments/multiple-choice.rst
🧠 Learnings (1)
📚 Learning: 2025-10-27T17:55:37.142Z
Learnt from: LolaValente
Repo: codio/knowledge PR: 426
File: source/instructors/authoring/assessments/llm-based-rubric.rst:61-61
Timestamp: 2025-10-27T17:55:37.142Z
Learning: In rst files for the Codio knowledge repository, image directive attributes (`:height:`, `:alt:`, etc.) should be indented with 3 spaces, not 4. Content following an image directive should not be indented unless it's intentionally part of that directive.
Applied to files:
source/instructors/authoring/assessments/grade-book.rst
🔇 Additional comments (5)
source/instructors/authoring/assessments/parsons-puzzle.rst (1)
58-64: Standardize punctuation consistency in Grading bullet list.The bullet items in the Grading section have inconsistent punctuation. Line 58 (Points) ends with a period, but lines 60, 61, 63, and 64 do not. For consistency, either add periods to all bullets or remove from all.
- **Points** - Enter the score if the student selects the correct answer. You can choose any positive numeric value. If this is an ungraded assessment, enter zero (0). - **Define Number of Attempts** - Enable to allow and set the number of attempts students can make for this assessment. If disabled, the student can make unlimited attempts. - **Show Rationale to Students** - Toggle to display the answer, and the rationale for the answer, to the student. This guidance information will be shown to students after they have submitted their answer and any time they view the assignment after marking it as completed. You can set when to show this selecting from **Never**, **After x attempts**, **If score is greater than or equal to a % of the total** or **Always** - **Rationale** - Enter guidance for the assessment. This is visible to the teacher when the project is opened in the course or when opening the student's project. This guidance information can also be shown to students after they have submitted their answer and when they reload the assignment after marking it as completed. - **Use Maximum Score** - Toggle to enable assessment final score to be the highest score attained of all runs. + **Points** - Enter the score if the student selects the correct answer. You can choose any positive numeric value. If this is an ungraded assessment, enter zero (0). + + **Define Number of Attempts** - Enable to allow and set the number of attempts students can make for this assessment. If disabled, the student can make unlimited attempts. + **Show Rationale to Students** - Toggle to display the answer, and the rationale for the answer, to the student. This guidance information will be shown to students after they have submitted their answer and any time they view the assignment after marking it as completed. You can set when to show this selecting from **Never**, **After x attempts**, **If score is greater than or equal to a % of the total** or **Always**. + + **Rationale** - Enter guidance for the assessment. This is visible to the teacher when the project is opened in the course or when opening the student's project. This guidance information can also be shown to students after they have submitted their answer and when they reload the assignment after marking it as completed. + **Use Maximum Score** - Toggle to enable assessment final score to be the highest score attained of all runs.Likely an incorrect or invalid review comment.
source/instructors/authoring/assessments/grade-book.rst (2)
11-28: Simplified steps and image directives are well-structured.The consolidation of General, Metadata, and Files guidance into concise steps is clear and follows the updated documentation pattern. Image formatting with proper 3-space attribute indentation adheres to style guidelines. The instructions for Show Name and Allow Partial Points are straightforward and accessible.
31-43: Approve restructured "Grading a Grade Book Assessment" section.The new top-level section with inline guidance is clear and well-organized. Image directives are properly formatted with correct alt text and width specifications. The flow from opening a student assignment to grading walkthrough is logical and easy to follow.
source/instructors/authoring/assessments/multiple-choice.rst (2)
23-39: General and Execution sections show clear, well-organized guidance with proper formatting.The Name description (line 26) is now clearer and more concise, successfully addressing earlier feedback. Image directives include appropriate width specifications (450px) with correct 3-space attribute indentation. Bullet points for Shuffle Answers, Multiple Response, Answers, and Ordering are straightforward and logically sequenced.
41-62: Grading section improvements are well-executed.Parameter descriptions have been significantly refined:
- Correct Points and Incorrect Points: Now consistent in format and tone (line 47–49).
- Define Number of Attempts (line 57): Successfully clarified per prior feedback.
- Show Rationale to Students (line 59): Now includes "When grades are released" option and clarified phrasing (e.g., "by selecting from" vs. "selecting from"), addressing earlier review comments.
- Allow Partial Points (line 51), Use Maximum Score (line 53), and Show Expected Answer (line 55) are concise and clear.
Image directive for the Grading section (lines 43–45) is properly formatted with width specification and correct attribute indentation.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
source/instructors/authoring/assessments/advanced-code-test.rst (2)
16-16: Add comma after "Files" for clarity (unresolved from previous review).This issue was flagged in the prior review but remains unaddressed. The sentence needs a comma before the cross-reference to clarify scope and improve readability.
-For more information on **General**, **Metadata** (Optional) and **Files** (Optional) see :ref:`Assessments <assessments>`. +For more information on **General**, **Metadata** (Optional) and **Files** (Optional), see :ref:`Assessments <assessments>`.
45-45: Add "by" before "selecting from" for grammatical clarity (unresolved from previous review).This phrasing issue was previously flagged and remains unfixed. The sentence lacks the preposition "by" needed for grammatical correctness.
-You can set when to show this selecting from **Never**, **After x attempts**, **If score is greater than or equal to a % of the total** or **Always** +You can set when to show this by selecting from **Never**, **After x attempts**, **If score is greater than or equal to a % of the total** or **Always**
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
source/instructors/authoring/assessments/advanced-code-test.rst(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rst
⚙️ CodeRabbit configuration file
**/*.rst: Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Clear and concise language.
- Correct grammar and spelling.
- Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
- Adherence to style guides (e.g., consistent tone, terminology).
Suggest improvements to enhance readability and accessibility.- Make sure to find all improvements on the first pass.
Go through the material multiple times before submitting comments.
Files:
source/instructors/authoring/assessments/advanced-code-test.rst
🔇 Additional comments (3)
source/instructors/authoring/assessments/advanced-code-test.rst (3)
38-40: Image formatting is consistent with PR consolidation patterns.The image block properly includes alt text and width specification (500px), aligning with the standardized formatting updates across assessment documentation in this PR.
1-8: Documentation structure and tone are clear.The introduction and overview sections are well-organized and maintain consistent terminology. The explanation of the .guides/secure folder requirements and namespace behavior is appropriately detailed.
18-49: Step-by-step workflow is logically ordered and easy to follow.The four-step setup process (General → Execution → Grading → Create) provides clear guidance. Subheadings, nested lists, and indentation improve scannability. The grading options are properly bulleted and concise.
2 participants
Summary by CodeRabbit