question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Refine Jupyter Notebooks Page in Docs

See original GitHub issue

🐞 Problem

https://docs.einsteinpy.org/en/latest/jupyter.html

We need to have more descriptive headings in this. Maybe link those headings to some pages. @rishi-s8 You may elaborate if you wish.

🎯 Goal

💡 Possible solutions

📋 Steps to solve the problem

  • Comment below about what you’ve started working on.
  • Add, commit, push your changes
  • Submit a pull request.
  • Add this in the comments:
    • Addresses #<put issue number here> if you are partially fixing the issue.
    • Fixes #<put issue number here> if you are completely fixing the issue.
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project 🎉

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:12 (5 by maintainers)

github_iconTop GitHub Comments

2reactions
rachittshahcommented, Nov 11, 2020

Problem

https://docs.einsteinpy.org/en/latest/jupyter.html

We need to have more descriptive headings in this. Maybe link those headings to some pages.

Goal

We should maybe make it more descriptive to use. A small summary or link to relevant article should be a good start Possible solutions

1.Add description of what the code does. 2.Mention a small summary of the problem we’re solving,and how we are solving it.

Steps to solve the problem

1.Research and repharse the doc files 2.Update as mentioned above.

  • Addresses #<put issue number here> if you are partially fixing the issue.
  • Fixes #<put issue number here> if you are completely fixing the issue.
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project tada

@shreyasbapat this is my line of thought for enhancement. May I work on this? Please let me know if I should change this approach.

1reaction
shreyasbapatcommented, Oct 15, 2020

Sure, please go ahead!

Read more comments on GitHub >

github_iconTop Results From Across the Web

some (markdown) page <-> Jupyter notebooks conversion ...
Answer: yes, here https://nbconvert.readthedocs.io/en/latest/ is a way to convert notebooks to markdown files. Then, when running Travis, you ...
Read more >
Jupyter Notebook Users Manual.ipynb - Bryn Mawr College
This page describes the functionality of the Jupyter electronic document system. Jupyter documents are called "notebooks" and can be seen as many things...
Read more >
Jupyter Notebook Documentation - Read the Docs
This will print some information about the notebook server in your console, and open a web browser to the URL of the web...
Read more >
The Jupyter Notebook as Document - YouTube
M Pacer (Project Jupyter | Berkeley Institute for Data Science), Jess Hamrick (UC Berkeley), Damián Avila (Anaconda Powered by Continuum ...
Read more >
Architecture — documentação Jupyter Documentation 4.1.1 ...
This page has information about the different architectural designs of core ... All the other interfaces —- the Notebook, the Qt console, ipython...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found