Skip to content

feat: add markdown explanations for key notebook cells#8

Merged
gaurav12301010 merged 2 commits intoOPCODE-Open-Spring-Fest:mainfrom
Satvik-Singh192:docs/add-markdown-explanations
Nov 15, 2025
Merged

feat: add markdown explanations for key notebook cells#8
gaurav12301010 merged 2 commits intoOPCODE-Open-Spring-Fest:mainfrom
Satvik-Singh192:docs/add-markdown-explanations

Conversation

@Satvik-Singh192
Copy link
Copy Markdown
Contributor

@Satvik-Singh192 Satvik-Singh192 commented Oct 17, 2025

Description

Added concise markdown explanations above major notebook cells (imports, data splitting, model definition, training) to improve code readability and clarity.

Semver Changes

  • Patch (bug fix, no new features)
  • Minor (new features, no breaking changes)
  • Major (breaking changes)

Issues

Closes #1

Checklist

@gaurav12301010
Copy link
Copy Markdown
Collaborator

Nice work on coming up with the solution!
Just a small suggestion — it’s always a good idea to add a short markdown note above each code cell. It helps explain what the code does and makes the notebook much easier to follow. Think of it like giving a quick intro before diving into the code.

I’d really appreciate it if you could include these markdown sections above there respective cells to make the notebook more organized and reader-friendly.

@Satvik-Singh192
Copy link
Copy Markdown
Contributor Author

@gaurav12301010 ok sir ,i will try my best

@Satvik-Singh192
Copy link
Copy Markdown
Contributor Author

@gaurav12301010 i made new changes as per your request and resolved the merge conflicts . please review my latest commit.

@gaurav12301010 gaurav12301010 changed the title docs: Add markdown explanations for key notebook cells fix: Add markdown explanations for key notebook cells Oct 22, 2025
@gaurav12301010 gaurav12301010 changed the title fix: Add markdown explanations for key notebook cells docs: Add markdown explanations for key notebook cells Oct 22, 2025
@gaurav12301010 gaurav12301010 changed the title docs: Add markdown explanations for key notebook cells feat: add markdown explanations for key notebook cells Oct 22, 2025
@gaurav12301010
Copy link
Copy Markdown
Collaborator

kindly ammend your comit and please validate it.

@Satvik-Singh192 Satvik-Singh192 force-pushed the docs/add-markdown-explanations branch from 2acbff8 to 769bce2 Compare October 23, 2025 10:29
@Satvik-Singh192
Copy link
Copy Markdown
Contributor Author

@gaurav12301010 i ammended my commit , please review it

@gaurav12301010
Copy link
Copy Markdown
Collaborator

Please review the commit rules before making changes. Once you’ve followed them, make your commits and then open the PR again.

@Satvik-Singh192 Satvik-Singh192 force-pushed the docs/add-markdown-explanations branch from 9adfcaf to b9f197b Compare November 8, 2025 04:08
@Satvik-Singh192 Satvik-Singh192 force-pushed the docs/add-markdown-explanations branch from b9f197b to c0a21eb Compare November 15, 2025 14:35
@gaurav12301010 gaurav12301010 merged commit a461a37 into OPCODE-Open-Spring-Fest:main Nov 15, 2025
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve Code Comments and Cell Descriptions

2 participants