-
-
Notifications
You must be signed in to change notification settings - Fork 53
[mix_model]: Fix issues and improve the lecture #642
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
📖 Netlify Preview Ready! Preview URL: https://pr-642--sunny-cactus-210e3e.netlify.app (fb4ddb0) 📚 Changed Lecture Pages: mix_model |
|
📖 Netlify Preview Ready! Preview URL: https://pr-642--sunny-cactus-210e3e.netlify.app (7cba5eb) 📚 Changed Lecture Pages: mix_model |
|
hi @mmcky , I have made some changes and made sure I pushed everything to this branch. although I have checked it myself, it'll be nice to have it reviewed by you :-) if there are further issues with the lecture, please let me know! |
|
📖 Netlify Preview Ready! Preview URL: https://pr-642--sunny-cactus-210e3e.netlify.app (67c3a4b) 📚 Changed Lecture Pages: mix_model |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR fixes formatting, style, and link issues in the mix_model lecture to align with style guidelines and improve readability. The changes primarily involve converting raw URLs to proper markdown links, fixing capitalization in headings, and correcting a few punctuation errors.
Key Changes
- Converted raw web links to proper markdown format with descriptive text
- Fixed capitalization in section headings to follow consistent style
- Made minor punctuation and text corrections
|
hi @mmcky, may I know if you have any thoughts on this? I would humbly request you to review this whenever you have the time :-) |
HumphreyYang
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Many thanks @bishmaybarik! These are great changes!
Noted that if we use
{doc}`lecture_name`
It will give use a hyperlink with the lecture title. So we can reduce the usage of "this lecture" in the lectures.
There are also a few lines of code that's touching 80-character limit so please have a go at breaking them into two lines!
Please let me know what you think.
|
Thanks for all the suggestions @HumphreyYang -- all of the suggestions are helpful! I'll make the necessary changes and update this PR as soon as possible. |
Co-authored-by: Humphrey Yang <[email protected]>
Co-authored-by: Humphrey Yang <[email protected]>
Co-authored-by: Humphrey Yang <[email protected]>
Co-authored-by: Humphrey Yang <[email protected]>
Co-authored-by: Humphrey Yang <[email protected]>
Co-authored-by: Humphrey Yang <[email protected]>
Adding a space between f and the text Co-authored-by: Humphrey Yang <[email protected]>
This might be out of the scope of this PR but we should only use bold for definitions Co-authored-by: Humphrey Yang <[email protected]>
|
📖 Netlify Preview Ready! Preview URL: https://pr-642--sunny-cactus-210e3e.netlify.app (77881b7) 📚 Changed Lecture Pages: mix_model |
Co-authored-by: Humphrey Yang <[email protected]>
|
thanks again for these great suggestions @HumphreyYang. All the changes have been made -- it would be great if you could have a look at it whenever you have time :-) |
|
📖 Netlify Preview Ready! Preview URL: https://pr-642--sunny-cactus-210e3e.netlify.app (5b63456) 📚 Changed Lecture Pages: mix_model |
|
📖 Netlify Preview Ready! Preview URL: https://pr-642--sunny-cactus-210e3e.netlify.app (76c9249) 📚 Changed Lecture Pages: mix_model |
|
📖 Netlify Preview Ready! Preview URL: https://pr-642--sunny-cactus-210e3e.netlify.app (aabecbc) 📚 Changed Lecture Pages: mix_model |
|
📖 Netlify Preview Ready! Preview URL: https://pr-642--sunny-cactus-210e3e.netlify.app (cc3bc96) 📚 Changed Lecture Pages: mix_model |
|
📖 Netlify Preview Ready! Preview URL: https://pr-642--sunny-cactus-210e3e.netlify.app (11f108d) 📚 Changed Lecture Pages: mix_model |
|
📖 Netlify Preview Ready! Preview URL: https://pr-642--sunny-cactus-210e3e.netlify.app (92cd96e) 📚 Changed Lecture Pages: mix_model |
|
📖 Netlify Preview Ready! Preview URL: https://pr-642--sunny-cactus-210e3e.netlify.app (4b926c0) 📚 Changed Lecture Pages: mix_model |
|
📖 Netlify Preview Ready! Preview URL: https://pr-642--sunny-cactus-210e3e.netlify.app (d7ed9ce) 📚 Changed Lecture Pages: mix_model |
This PR fixes the following issues:
The issue was the following:
link text,doclinks.