IP restriction and partial points indicator

[shajason]

Summary by CodeRabbit

• Documentation
  • Added "Feedback for Partial Points" docs describing the orange percent indicator, supported feedback formats (HTML, Markdown, plaintext), and JavaScript/Python examples for sending partial-point feedback.
  • Expanded exam proctoring & assignment setup docs with IP restriction guidance, clearer extension management with visible indicators, single-login prerequisites/behavior, terminology updates, and new illustrative images.
• Changelog
  • Added a September 2025 entry for IP restriction support.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation updates across instructor guides: adds a "Feedback for Partial Points" subsection with V2 autograding parameters and examples; inserts a September 2025 changelog entry for IP restriction; and expands exam-proctoring guidance with extend-time UI details, visible extension indicators, Single Login prerequisites, and a new "Restrict IP Addresses" subsection.

Changes

Cohort / File(s)	Summary
Partial Points Feedback Documentation source/instructors/authoring/assessments/partial-points.rst	Adds "Feedback for Partial Points" subsection and indicators.png. Documents CODIO_PARTIAL_POINTS_V2_URL parameters (Score, Feedback, Format), describes send_partial_v2 helper and exit-code expectations, notes orange percent UI cue, and adds JavaScript and Python examples.
Changelog Updates source/instructors/getstarted/support/changelog.rst	Adds September 2025 feature entry for restricting IP addresses (exam-proctoring). Minor reordering and formatting adjustments to neighboring changelog entries.
Exam Proctoring Feature Expansion source/instructors/setupcourses/assignment-settings/exam-proctoring.rst	Rephrases menu wording to "menu icon (3 horizontal dots)"; standardizes extend-time guidance and image blocks; adds visible extension indicator and image; expands Single Login prerequisites (stable internet, power, sufficient time); introduces "Restrict IP Addresses" subsection with per-line IP/subnet entry guidance and illustrative image; normalizes bullets and captions.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Verify accuracy of JS/Python examples and HTTP parameter names/format for CODIO_PARTIAL_POINTS_V2_URL.
• Confirm referenced images (indicators.png, extension/IP screenshots) are present and render with correct alt text and captions.
• Check consistency of UI wording ("menu icon (3 horizontal dots)") across docs and image captions.
• Validate changelog placement and date formatting.

Possibly related PRs

• assessments update part 2 #430 — Modifies autograding/partial-points documentation and V2 reporting; strong overlap.
• assessment updates 3 #433 — Revises the same partial-points docs and example code; likely directly related.

Suggested reviewers

• LolaValente
• jairovelasquez

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly aligns with the two main features introduced: IP address restriction capabilities and partial points indicator enhancements.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ead2256 and bc0aeb4.

⛔ Files ignored due to path filters (2)

• source/img/extendtime.png is excluded by !**/*.png, !**/*.png
• source/img/guides/indicators.png is excluded by !**/*.png, !**/*.png

📒 Files selected for processing (2)

• source/instructors/authoring/assessments/partial-points.rst (1 hunks)
• source/instructors/setupcourses/assignment-settings/exam-proctoring.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).
• Anywhere there are tables, they should use list-table.
• 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/setupcourses/assignment-settings/exam-proctoring.rst
• source/instructors/authoring/assessments/partial-points.rst

🔇 Additional comments (7)

source/instructors/setupcourses/assignment-settings/exam-proctoring.rst (5)

1-19: Strong intro and heading structure. Line 9's terminology change to "exam assignments" is grammatically sound and improves clarity. Formatting is consistent throughout.

---

20-28: Clear action sequencing and visual indicators implemented. Line 20 now explicitly guides users through the action flow ("then click"), and the new image blocks on lines 22-28 effectively illustrate the extend time UI and resulting dashboard indicator. Tense consistency is maintained throughout.

---

30-34: Consistent formatting maintained. Bullet structure and language are clear and parallel with other feature sections.

---

37-55: Single Login prerequisites effectively formatted. The expanded bullet list (lines 41-47) clearly delineates student requirements and is easy to scan. The guidance on instructor resets and access restrictions is appropriately detailed.

---

57-60: Verify Single Login reference implementation. Past review comments flagged that the Single Login reference on line 57 should be converted to a proper RST cross-reference link (suggested syntax: Single Login_), with status marked as addressed. However, the current code shows "(see above)" instead of a link reference.

If a cross-reference link is intended, ensure the Single Login section has a corresponding reference label (e.g., .. _single-login:) to make the link valid. If descriptive text is intentional, this is acceptable but note the discrepancy from the previous review outcome.

The rest of the section is well-written: the comma after "enabled" is correctly placed, "IPs and IP ranges" wording is clear, and the image block is properly formatted with descriptive alt text.

source/instructors/authoring/assessments/partial-points.rst (2)

10-15: Well structured with proper formatting.

The new subsection uses consistent RST syntax, appropriate bold emphasis (addressing the prior review feedback), and includes a descriptive image with alt text. No issues here.

---

121-154: Older method section is well-structured and clear.

The section appropriately distinguishes the older partial points method from the new V2 approach, and the important directive provides helpful guidance. No issues detected.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 142b597 and 729c66e.

⛔ Files ignored due to path filters (5)

• source/img/assignmentsettings/extendedtime.png is excluded by !**/*.png, !**/*.png
• source/img/assignmentsettings/restrictip.png is excluded by !**/*.png, !**/*.png
• source/img/examproctoring.png is excluded by !**/*.png, !**/*.png
• source/img/extendtime.png is excluded by !**/*.png, !**/*.png
• source/img/guides/indicators.png is excluded by !**/*.png, !**/*.png

📒 Files selected for processing (3)

• source/instructors/authoring/assessments/partial-points.rst (1 hunks)
• source/instructors/getstarted/support/changelog.rst (1 hunks)
• source/instructors/setupcourses/assignment-settings/exam-proctoring.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).
• Anywhere there are tables, they should use list-table.
• 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/setupcourses/assignment-settings/exam-proctoring.rst
• source/instructors/authoring/assessments/partial-points.rst
• source/instructors/getstarted/support/changelog.rst

🔇 Additional comments (2)

source/instructors/authoring/assessments/partial-points.rst (1)

10-118: Well-structured addition with clear examples.

The new "Feedback for Partial Points" subsection is well-integrated with proper RST formatting. The documentation clearly explains the V2 URL parameters, provides practical JavaScript and Python examples, and visually cues partial point scoring with the orange percent indicator. Code examples are properly formatted and illustrative.

source/instructors/setupcourses/assignment-settings/exam-proctoring.rst (1)

20-60: Terminology standardized and new proctoring features clearly documented.

The update to explicit "menu icon (3 horizontal dots)" terminology at line 20 (and consistently at line 55) improves clarity and consistency with other documentation sections. The new subsections on extension indicators (lines 25–28), single login behavior (lines 42–47, 49–55), and IP address restrictions (lines 57–60) are well-written and practical. The IP restriction section clearly states the prerequisite (Single Login must be enabled) and expected behavior.

[coderabbitai]

Actionable comments posted: 2

♻️ Duplicate comments (1)

source/instructors/getstarted/support/changelog.rst (1)

32-33: Chronological ordering now corrected.

The September 2025 entries are now properly ordered in reverse chronological sequence (30th before 29th), resolving the previous concern about forward ordering. The changelog maintains consistent reverse chronological order as established throughout the document.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 729c66e and 3755470.

📒 Files selected for processing (2)

• source/instructors/getstarted/support/changelog.rst (1 hunks)
• source/instructors/setupcourses/assignment-settings/exam-proctoring.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).
• Anywhere there are tables, they should use list-table.
• 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/getstarted/support/changelog.rst
• source/instructors/setupcourses/assignment-settings/exam-proctoring.rst

🔇 Additional comments (1)

source/instructors/setupcourses/assignment-settings/exam-proctoring.rst (1)

1-61: RST syntax, formatting, and documentation structure are well-executed.

The documentation file demonstrates strong RST compliance: proper image references with alt text, consistent bullet-point indentation, correct reference syntax, and well-organized sections. The new "Restrict IP Addresses" section integrates smoothly with existing content. The expanded Single Login prerequisites and Extend Time workflow are clearly presented. The overall structure supports the documentation's instructional goals effectively.

[coderabbitai]

Actionable comments posted: 2

♻️ Duplicate comments (2)

source/instructors/setupcourses/assignment-settings/exam-proctoring.rst (2)

20-20: Duplicate: Action sequencing clarification already applied.

The phrasing now includes "and then click Extend Time" as suggested in the prior review, which properly clarifies the action sequence.

---

57-57: Duplicate: Restrict IP Addresses formatting consistency already applied.

The section correctly emphasizes Restrict IP Addresses and Single Login with bold formatting, matching the style of other section labels. The previous suggestion for consistent formatting appears to have been implemented.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3755470 and ead2256.

📒 Files selected for processing (1)

• source/instructors/setupcourses/assignment-settings/exam-proctoring.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).
• Anywhere there are tables, they should use list-table.
• 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/setupcourses/assignment-settings/exam-proctoring.rst

🔇 Additional comments (2)

source/instructors/setupcourses/assignment-settings/exam-proctoring.rst (2)

39-55: Approve content and formatting of Single Login section.

The expanded Single Login section is well-structured with clear prerequisites and explanatory text. The bullet list formatting is consistent, and the guidance about access restrictions and the reset procedure is clear and properly emphasized.

---

1-62: Overall RST syntax and structure is sound.

The file maintains proper reStructuredText formatting throughout, including correct heading levels, image directives with alt text, bullet list consistency, and proper emphasis markers. The new content integrates well with existing sections, and the documentation maintains clear, instructional language suitable for the audience.