Skip to content

Updated information on resetting assignment on the Modify assignment …#424

Merged
shajason merged 4 commits intomasterfrom
fixmodifyassignment
Oct 23, 2025
Merged

Updated information on resetting assignment on the Modify assignment …#424
shajason merged 4 commits intomasterfrom
fixmodifyassignment

Conversation

@shajason
Copy link
Collaborator

@shajason shajason commented Oct 23, 2025

…page

Please hold off on the review until I am done with the CodeRabbit feedback.

Summary by CodeRabbit

  • Documentation
    • Updated instructor docs for the assignment reset workflow to reflect the revised UI steps (now via the More Actions menu) and the updated Reset placement.
    • Clarified step-by-step instructions for resetting assignments for individual students and all students, refined wording and punctuation, and added a new visual aid illustrating the reset-all flow.

@shajason shajason requested a review from LolaValente October 23, 2025 20:56
@coderabbitai
Copy link

coderabbitai bot commented Oct 23, 2025

Warning

Rate limit exceeded

@shajason has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 8 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 792ed04 and 75417c7.

📒 Files selected for processing (1)
  • source/instructors/setupcourses/modify-assignments.rst (2 hunks)

Walkthrough

Updated instructor documentation for the assignment reset workflow: navigation steps and button/menu labels revised to match the current UI; reset action location updated; wording refined; an image illustrating the all-students reset workflow was added. (34 words)

Changes

Cohort / File(s) Summary
Documentation UI Updates
source/instructors/setupcourses/modify-assignments.rst
Revised assignment reset instructions: replaced “3 blue dot” reference with “More Actions (3-dot)” menu, moved Reset action description to the bottom of that menu, refined wording for clarity, and added an illustrative image for the all-students reset workflow.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Rationale: Single-file documentation update with consistent, localized edits (UI wording changes, minor copy refinements, and one image addition). Review focuses on verifying UI text accuracy and image placement.

Possibly related PRs

  • LTIUpdateandotherfixes #418 — Updates instructor documentation for the assignment reset/actions flow with similar wording changes about where “Reset” is found and how it’s described.

Pre-merge checks

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "Updated information on resetting assignment on the Modify assignment…" directly and clearly describes the primary change in the PR, which involves updating documentation for assignment reset flows (both for individual and all students) in the modify-assignments.rst file. The title is specific, concise, and accurately captures the essence of the changeset without being vague or generic. A teammate reviewing the PR history would immediately understand that this PR updates documentation related to assignment reset functionality.

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

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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 9aeb774 and 4f11574.

⛔ Files ignored due to path filters (1)
  • source/img/class_administration/resetassignment.png is excluded by !**/*.png, !**/*.png
📒 Files selected for processing (1)
  • source/instructors/setupcourses/modify-assignments.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.

Files:

  • source/instructors/setupcourses/modify-assignments.rst
🔇 Additional comments (2)
source/instructors/setupcourses/modify-assignments.rst (2)

45-46: Clear, well-structured steps for all-students reset workflow.

The updated steps are concise and logically ordered. The Oxford comma usage and consistent bold formatting for UI elements enhance readability. The reference to "see image below" appropriately directs users to the accompanying visual aid.


49-50: Image file verified and RST syntax is correct.

The image file (resetassignment.png) has been successfully added to the repository at source/img/class_administration/, and the RST directive syntax is properly formatted with a clear, descriptive alt text. No issues found.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 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 4f11574 and a854b06.

📒 Files selected for processing (1)
  • source/instructors/setupcourses/modify-assignments.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.

Files:

  • source/instructors/setupcourses/modify-assignments.rst
🔇 Additional comments (2)
source/instructors/setupcourses/modify-assignments.rst (2)

45-46: Clear, well-structured update with improved punctuation.

The added Oxford comma in line 45 enhances readability and creates better parallel structure for the multi-step instruction. The revised steps provide clear navigation guidance with appropriate cross-reference to the visual aid below.


49-50: Image syntax and alt text are correct.

The reStructuredText image directive is properly formatted with descriptive alt text. The image placement supports the workflow documentation effectively.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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 a854b06 and 792ed04.

📒 Files selected for processing (1)
  • source/instructors/setupcourses/modify-assignments.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.

Files:

  • source/instructors/setupcourses/modify-assignments.rst
🔇 Additional comments (3)
source/instructors/setupcourses/modify-assignments.rst (3)

35-36: Terminology and instruction clarity improvements look good.

The change from "3 dot" to "three-dot" is more professional and clear, and the new instruction on line 36 specifying that Reset is a menu item "at the bottom" provides better guidance for instructors. Both changes improve readability and UI terminology consistency.


45-46: Clear procedural updates with improved consistency.

The Oxford comma is now included in line 45, and line 46 appropriately references the image below, providing better instructional clarity. The shift from "Reset button" to "Reset option" aligns with the updated UI terminology.


49-50: Image directive syntax is correct.

The RST image directive syntax is properly formatted with a descriptive alt text. Ensure that the image file path /img/class_administration/resetassignment.png is valid and accessible in the documentation build.

@shajason shajason merged commit 244d59f into master Oct 23, 2025
1 check passed
@shajason shajason deleted the fixmodifyassignment branch October 23, 2025 21:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants