Reorganize examples and update readme / contents #121 #124
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
Caution Review failedThe pull request is closed. WalkthroughThis pull request reorganizes and expands the examples documentation. The Changes
Assessment against linked issues
Poem
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
examples/README.md (1)
12-13: Fix indentation for consistency in list items.The indentation of these list items uses tabs instead of spaces, which is inconsistent with standard Markdown formatting.
- - Events data from version 1.2 of Shakespeare and Company Project datasets - - [Partial date duration logic](shxco_partial_date_durations.ipynb) - compare `undate` partial date range duration logic with a previous implementation in the _Shakespeare and Company Project_ (jupyter notebook) + - Events data from version 1.2 of Shakespeare and Company Project datasets + - [Partial date duration logic](shxco_partial_date_durations.ipynb) - compare `undate` partial date range duration logic with a previous implementation in the _Shakespeare and Company Project_ (jupyter notebook)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
12-12: Unordered list indentation
Expected: 2; Actual: 1(MD007, ul-indent)
12-12: Hard tabs
Column: 1(MD010, no-hard-tabs)
13-13: Unordered list indentation
Expected: 2; Actual: 1(MD007, ul-indent)
13-13: Hard tabs
Column: 1(MD010, no-hard-tabs)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
examples/shakespeare-and-company-project/SCoData_events_v1.2_2022-01.csvis excluded by!**/*.csv
📒 Files selected for processing (4)
examples/README.md(1 hunks)examples/edtf-support.ipynb(12 hunks)examples/notebooks/README.md(0 hunks)examples/shakespeare-and-company-project/shxco_partial_date_durations.ipynb(42 hunks)
💤 Files with no reviewable changes (1)
- examples/notebooks/README.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
examples/README.md
12-12: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
12-12: Hard tabs
Column: 1
(MD010, no-hard-tabs)
13-13: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
13-13: Hard tabs
Column: 1
(MD010, no-hard-tabs)
🔇 Additional comments (3)
examples/shakespeare-and-company-project/shxco_partial_date_durations.ipynb (1)
299-300: Improved dataset organization and path clarity.The dataset path has been updated to expect the data file in the same directory as the notebook, with a corresponding comment update. This change improves self-containment of the example and makes it clearer where the dataset should be located.
examples/README.md (1)
3-13: Well-structured documentation improves usability.The expanded introduction and structured Contents section greatly improve clarity about the available examples and their purpose. This makes it easier for users to understand and navigate the examples.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
12-12: Unordered list indentation
Expected: 2; Actual: 1(MD007, ul-indent)
12-12: Hard tabs
Column: 1(MD010, no-hard-tabs)
13-13: Unordered list indentation
Expected: 2; Actual: 1(MD007, ul-indent)
13-13: Hard tabs
Column: 1(MD010, no-hard-tabs)
examples/edtf-support.ipynb (1)
58-692: Sequential execution counts improve notebook readability.Execution counts have been properly renumbered to start from 1 and proceed sequentially, which improves the clarity of execution flow in the notebook.
resolves #121
Summary by CodeRabbit
Documentation
Chores