Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs not present for Ricci Tensor & Vacuum Metrics #267

Closed
ritzvik opened this issue Jul 1, 2019 · 12 comments

Comments

@ritzvik
Copy link
Member

commented Jul 1, 2019

Possible solutions

  • Additions in docs/source/api/symbolic/symbolic_index.rst

  • New files docs/source/api/symbolic/ricci.rst, docs/source/api/symbolic/vacuum_metric.rst

  • Add vacuum_metric to symbolic/__init__.py

馃搵 Steps to solve the problem

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project 馃帀
@ritzvik ritzvik referenced this issue Jul 1, 2019
@OVSofia

This comment has been minimized.

Copy link
Contributor

commented Jul 1, 2019

Instead of "vacuum_metric.rst" vacuum_metrics.rst, right? (with S)

@OVSofia

This comment has been minimized.

Copy link
Contributor

commented Jul 1, 2019

"Additions in docs/source/api/symbolic/symbolic_index.rst"
I do not add either einstein or stress_energy_momentum, since they still don't work.
So, tell me if I have to add it

@OVSofia

This comment has been minimized.

Copy link
Contributor

commented Jul 1, 2019

I could not link my last commit with this task, but it's done in it.
Next time I will write the issue number in the commit to make sure

@ritzvik

This comment has been minimized.

Copy link
Member Author

commented Jul 1, 2019

Instead of "vacuum_metric.rst" vacuum_metrics.rst, right? (with S)

whatever you named the .py file

"Additions in docs/source/api/symbolic/symbolic_index.rst"
I do not add either einstein or stress_energy_momentum, since they still don't work.
So, tell me if I have to add it

No, only add those which you have completed.

@shreyasbapat shreyasbapat added this to the 0.2 milestone Jul 1, 2019

@shreyasbapat

This comment has been minimized.

Copy link
Member

commented Jul 1, 2019

Fix this ASAP!

@OVSofia

This comment has been minimized.

Copy link
Contributor

commented Jul 1, 2019

I think thath is already fixed.

@ritzvik

This comment has been minimized.

Copy link
Member Author

commented Jul 1, 2019

I think thath is already fixed.

Nopes.
I already told you to learn how to add documentation from PR #241
You need to add new files in docs/source/api/symbolic and edit the index there.

@OVSofia

This comment has been minimized.

Copy link
Contributor

commented Jul 1, 2019

That's what I think I've done

@OVSofia

This comment has been minimized.

Copy link
Contributor

commented Jul 1, 2019

Create ricci.rst:
Ricci Tensor Module

This module contains the class for obtaining Ricci Tensor
related to a Metric belonging to any arbitrary space-time symbolically:

.. automodule:: einsteinpy.symbolic.ricci
:members:

and vacuum_metrics.rst:
Vacuum Metrics Tensor Module

This module contains the definition Schwarzschild Metric
related to a Metric belonging to any arbitrary space-time symbolically:

.. automodule:: einsteinpy.symbolic.vacuum_metrics
:members:

in docs/source/api/symbolic

Its not this?

@ritzvik

This comment has been minimized.

Copy link
Member Author

commented Jul 1, 2019

In einsteinpy/symbolic/__init__.py, you would also need to add the line from vacuum_metrics import SchwarzschildMetric. Remember black & isort OR tox.

Create ricci.rst:

Ricci Tensor Module
This module contains the class for obtaining Ricci Tensor
related to a Metric belonging to any arbitrary space-time symbolically:

.. automodule:: einsteinpy.symbolic.ricci
:members:

and vacuum_metrics.rst:

Vacuum Metrics Tensor Module
This module contains the definition Schwarzschild Metric
related to a Metric belonging to any arbitrary space-time symbolically:

.. automodule:: einsteinpy.symbolic.vacuum_metrics
:members:

in docs/source/api/symbolic

Its not this?

Yes, add these, make a new PR with a new branch.

Also add:

  • vacuum_metrics and
  • ricci

in docs/source/api/symbolic/symbolic_index.rst

@OVSofia OVSofia referenced this issue Jul 1, 2019
@OVSofia

This comment has been minimized.

Copy link
Contributor

commented Jul 1, 2019

I think I did all this when I did the push this morning, so I've done a PR of my commit to try to clarify this issue and finally close it :)

@OVSofia

This comment has been minimized.

Copy link
Contributor

commented Jul 1, 2019

Just in case I've create a new branch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can鈥檛 perform that action at this time.