Re: [sympy] Sympy Document

2020-06-18 Thread Soumi7
Please provide a link to your PR that was merged. On Saturday, June 6, 2020 at 9:28:58 PM UTC+5:30, Mohit Shah wrote: > > Hello, > how to format return statement in docstring. > In my previous PR which was merged, I make it as: > > *return-type :* > *Brief explanation of what it is

Re: [sympy] Re: GSOD Project Discussuion

2020-06-18 Thread Soumi7
> > Next I want to get started with implementing the style guide to > functions.elementary. However, Before that I think it is important to decide the order of the subheaders. @nikhil maan For the time being there can be two approaches for me: 1. Proceed with the latest existing guide but

[sympy] Re: GSOD Project Discussuion

2020-06-18 Thread Soumi7
Yes, I looked at the core docs too. They are outdated and the docstrings have to be edited to adhere to the latest documentation style guide. Will work on this. On Friday, June 19, 2020 at 2:13:30 AM UTC+5:30, S.Y. Lee wrote: > > It depends on what kind of topics you are comfortable to work

Re: [sympy] GSOD Project Discussuion

2020-06-18 Thread Soumi7
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.

Re: [sympy] GSOD Project Discussuion

2020-06-18 Thread Soumi7
[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

Re: [sympy] GSOD Project Discussuion

2020-06-18 Thread Soumi7
[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

Re: [sympy] Re: GSOD Project Discussuion

2020-06-18 Thread Aaron Meurer
Regarding opening issues, I noticed that we don't have an issue tracking the documentation style guide, so I opened https://github.com/sympy/sympy/issues/19591. This issue will track all the modules that need to be updated to the style guide, so that we don't have multiple issues. For those with

[sympy] Re: Integer Factorization

2020-06-18 Thread S.Y. Lee
What is factorDB? Does it offer any fast algorithm for factoring integers in its own, or does it requires some internet connection to access a database of integer factors. Although I'm open to any possibilities, but I'm not sure that stuff needs internet connection can be in a scope of

[sympy] Re: GSOD Project Discussuion

2020-06-18 Thread S.Y. Lee
It depends on what kind of topics you are comfortable to work with, but I'm sure that even the core docs are too outdated https://docs.sympy.org/latest/modules/core.html and doesn't follow the style guide. On Wednesday, June 10, 2020 at 2:04:13 PM UTC+9, Soumi7 wrote: > > I want to do a GSOD

Re: [sympy] GSOD Project Discussuion

2020-06-18 Thread Nikhil Maan
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

[sympy] Integer Factorization

2020-06-18 Thread Thariqul Abrar
Hi, I was just factoring a large number for fun "10309277446862669975817743540791642140663368905539849109663750903470477975" with sympy factorint function it took a long time but with Factordb.com API I got the result within seconds.Since sympy is open source why can't sympy make use of

Re: [sympy] GSOD Project Discussuion

2020-06-18 Thread Soumi7
> > 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

Re: [sympy] GSOD Project Discussuion

2020-06-18 Thread Soumi7
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