Skip to content

updated table and photo#453

Merged
LolaValente merged 4 commits intomasterfrom
updatebulkassignment
Jan 28, 2026
Merged

updated table and photo#453
LolaValente merged 4 commits intomasterfrom
updatebulkassignment

Conversation

@LolaValente
Copy link
Collaborator

@LolaValente LolaValente commented Jan 28, 2026

Summary by CodeRabbit

  • Documentation
    • Restructured bulk-assignment CSV guidance into a clearer list-table format with standardized headings, updated image reference, expanded field definitions, and formatting improvements.
    • Added new visibility fields for completed/disabled assignments and clarified data types, possible values, and examples.
    • Added a January 2026 changelog note about a new Previous button appearing in guides when forward-only navigation is disabled.

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

@LolaValente LolaValente requested a review from shajason January 28, 2026 17:08
@coderabbitai
Copy link

coderabbitai bot commented Jan 28, 2026

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

  • 🔍 Trigger a full review

Walkthrough

Restructured CSV bulk-assignment documentation: replaced a large Markdown table with an reStructuredText list-table, standardized CSV/CSV template wording, updated image path, added two new visibility fields, and expanded field metadata and descriptions.

Changes

Cohort / File(s) Summary
Bulk assignment CSV docs
source/instructors/setupcourses/bulk-assignment-update.rst
Replaced Markdown multi-column table with an reStructuredText list-table titled "Assignment Configuration Fields"; standardized "CSV template/file" phrasing; updated image path to /img/guides/...; added visibility_on_completed and visibility_on_disabled fields; revised field descriptions, data types, and possible values; adjusted headings and minor copy edits.
Changelog entry
source/instructors/getstarted/support/changelog.rst
Added January 2026 changelog bullet about a Previous button in guides when Forward Only Navigation is not enabled.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • shajason
🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title "updated table and photo" is vague and generic. While it references real elements in the changeset, it doesn't capture the substantial documentation improvements, CSV template restructuring, or the specific purpose of the updates. Consider a more descriptive title such as "Restructure CSV bulk assignment template documentation and update image path" to clearly convey the scope and intent of the changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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.

❤️ Share

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

@LolaValente
Copy link
Collaborator Author

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Jan 28, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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: 6

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (3)
source/instructors/setupcourses/bulk-assignment-update.rst (3)

10-10: Break up this run-on sentence for better readability.

This sentence is overly long and lists multiple settings with nested references, making it difficult to parse. Consider breaking it into 2-3 shorter sentences or using a bullet list to introduce the settings that can be bulk-updated.

♻️ Proposed revision
-You have the ability to perform a bulk update for various assignment settings, including start date/time of the assignment, closing date/time of the assignment, action when assignment closes, due dates and penalties. For more information about these settings, see :ref:`Assignment Duration <assignment-duration>`, :ref:`Prime Assignment Containers <prime-assignment-containers>` and :ref:`Virtual Coach <enable-vc-bulk>` settings using a CSV file.
+You can perform bulk updates for various assignment settings using a CSV file. These settings include:
+
+- Start and closing date/time
+- Action when assignment closes
+- Due dates and penalties
+- :ref:`Assignment Duration <assignment-duration>` settings
+- :ref:`Prime Assignment Containers <prime-assignment-containers>` settings
+- :ref:`Virtual Coach <enable-vc-bulk>` settings

13-14: Remove redundancy and improve clarity.

The phrase "download the csv template file" appears twice in close proximity, creating unnecessary repetition. Additionally, "requirement(s)" is awkward, and "csv" should be capitalized as "CSV" throughout the document for consistency.

♻️ Proposed revision
-Before you begin, make sure to download the csv template file. You can download the csv template file of your course from  "Download Assignment Information" present in the  "Bulk Settings area". You can update the fields as per your requirement(s) and use that csv file to update the assignment settings. 
-Here is a sample screenshot of the csv template:
+Before you begin, download the CSV template file for your course from "Download Assignment Information" in the "Bulk Settings area". You can update the fields as needed and then use the CSV file to update the assignment settings.
+
+Here is a sample screenshot of the CSV template:

117-119: Remove redundancy and fix punctuation.

"Updated/modified" is redundant (both mean the same thing in this context). Also, missing a period at the end of the sentence on line 119.

♻️ Proposed revision
-Once you have updated/modified your csv template file now you are ready to bulk update the assignment settings.
+Once you have updated your CSV template file, you are ready to bulk update the assignment settings.
 
-To bulk update the assignments settings, follow these steps:
+To bulk update the assignment settings, follow these steps:
🤖 Fix all issues with AI agents
In `@source/instructors/setupcourses/bulk-assignment-update.rst`:
- Around line 56-57: Standardize the date/time wording for all affected fields
(start_time, closing_time, due_at, prime_time) to a consistent format such as
"mm/dd/yyyy h:mm AM/PM" (use leading zeros for month/day consistently, e.g.,
05/02/2025 09:11 AM) and replace the unclear "morning or night (XX)" with "AM or
PM"; also fix the grammatical error by avoiding "its"—use phrasing like "Specify
the start time and date in mm/dd/yyyy h:mm AM/PM format" for each occurrence
(start_time, closing_time, due_at, prime_time).
- Line 89: The sentence starting with "Identify the lowest possible grade a
student can receive for this assignment. Note: For more information on penalty
deductions, please see :ref:`Penalties <penalties>`" should be split and
punctuated: end the main sentence with a period, remove the inline "Note:" and
place "Note: For more information on penalty deductions, please see
:ref:`Penalties <penalties>`" as its own sentence (or a separate note block) so
the note is clearly separated from the main instruction; update the text around
the identifier "Identify the lowest possible grade a student can receive for
this assignment" accordingly.
- Line 101: Edit the sentence "- In this cell you will specify the Number of
Students that will start the assignment at the same time. Note: For more
information about this setting, please visit :ref:`Prime Assignment Containers
<prime-assignment-containers>`" to remove the leading "In this cell", change
"Number of Students" to "number of students" (lowercase), and convert the
"Note:" portion into a proper Sphinx note or parenthetical note so the reference
to :ref:`Prime Assignment Containers <prime-assignment-containers>` remains but
is formatted more clearly (e.g., "For more information, see :ref:`Prime
Assignment Containers <prime-assignment-containers>`" inside the note).
- Line 45: Replace the awkward phrase "The assignment name goes in this cell."
with clearer CSV-oriented wording; update the sentence (in
bulk-assignment-update.rst) to something like "Enter the assignment name in this
column" or "Put the assignment name in the assignment_name column" so readers
understand it refers to a CSV column rather than a spreadsheet cell.
- Around line 64-65: Replace the inline prose that describes the three close
actions with a properly formatted reStructuredText list so the options are easy
to scan; locate the line containing "DISABLE_AND_COMPLETE, DISABLE, COMPLETE"
and the following sentence and convert the numbered prose ("1. Disable
assignment and mark as complete 2. Disable assignment 3. Mark as complete") into
either a numbered list or a bullet list with each option as its own line,
ensuring the wording for the first item matches the constant name
(DISABLE_AND_COMPLETE) and uses consistent enumeration style.
- Around line 22-27: Fix grammar and formatting in the "Things you should know
about the csv template:" section: change "csv" to "CSV", correct "All field are"
to "All fields are", change "the specific field" to "a specific field", remove
the extra spaces before "If the specific field", and ensure consistent
capitalization and punctuation across the bullet points (refer to the header
text "Things you should know about the csv template" and the bullets describing
header names, field updates, case-insensitivity, and Prime Setting behavior).

@LolaValente
Copy link
Collaborator Author

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Jan 28, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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: 3

🤖 Fix all issues with AI agents
In `@source/instructors/setupcourses/bulk-assignment-update.rst`:
- Line 13: The sentence contains double spaces before the phrases "Download
Assignment Information" and "Bulk Settings area"; edit the string in the
bulk-assignment-update text so each instance uses a single space (e.g., change
the segment containing “from  “Download Assignment Information”” and “in the 
“Bulk Settings area”” to use single spaces before those quoted phrases) to
normalize spacing.
- Line 117: The sentence "Once you have updated/modified your CSV template file
now you are ready to bulk update the assignment settings" has awkward word
order; update it to a clearer phrasing such as "Once you have updated or
modified your CSV template file, you are ready to bulk update the assignment
settings" or more concisely "After updating your CSV template file, you are
ready to bulk update the assignment settings" by editing the sentence in the
sentence block in bulk-assignment-update.rst.
- Around line 78-85: Update the descriptions for the fields deduction_interval
and deduction_percent in the table: remove the phrase "in this cell you
identify" and rewrite them to be concise and consistent with other fields—e.g.,
for deduction_interval use "Identify whether the deduction is by hour or by day
after the due date." and for deduction_percent use "Identify the deduction
percentage as a whole number (e.g., 5 for 5%)." Ensure the edits are applied to
the deduction_interval and deduction_percent rows.

Copy link
Collaborator

@shajason shajason left a comment

Choose a reason for hiding this comment

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

The text in the table could be tightened up - I provided some suggestions.

@LolaValente LolaValente merged commit 815464b into master Jan 28, 2026
1 check passed
@LolaValente LolaValente deleted the updatebulkassignment branch January 28, 2026 21:27
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