As suggested by asmeurer, editing all docstrings throughtout sympy to
adhere to the already existing style guide will be a big task, so I am not
sure if I should add new sections.
I can change the location of the Parameters list to appear before examples
as I think that will be beneficial.
[image: kk.png]
Before implementing the new style guide, we should finalize the location of
parameters list and add the returns section as you suggested.
Here is a proposed view.
On Friday, June 19, 2020 at 12:25:04 AM UTC+5:30, Nikhil Maan wrote:
>
> You can submit PRs and open issues
[image: kk.png]
This are the proposed changes. I read the other conversation with Mohit
about the proposed sections. That can be implemented or mine as well.
So when we implement the new styling guide, the location of Parameters
section will have to be changed and the returns section will be
You can submit PRs and open issues whenever you feel comfortable and are
free to contribute. Contributions are always welcome with or without the
program.
Also, since you're planning to update the docstrings throughout the project
to match the style guide, I think we should have a discussion
>
> I submitted a PR editing some of the docstrings of the specials submodule
> to adhere to the style guide which was merged.
Should I open issues and start submitting PRs for the other submodules
already or should I do that later as a part of the project itself?
--
You received this
I think that is right, most docstrings across sympy do not follow the style
guide developed previously. It is a lot of work and I shall limit my
project to it.
Right now, the changes have been applied to the specials submodule only,
The aim of this project will be to edit all docstrings
Hi.
Sorry for not replying sooner to this. I think this is a good project.
However, I would suggest restricting the project to only fixing the
existing documentation. This is in itself quite a bit of work,
considering that SymPy has a lot of documentation and most of it
hasn't been updated to
I want to do a GSOD project and I would like to discuss it with the mentors
before submitting the proposal.
My goal would be to update docstrings throughout sympy to adhere to Lauren
Glatty's guide style guide that was developed previously.
This would include adding docstrings and doctests where
