example modified

[Yathartha22]

In bivariate.py function named _mostfunc has an example that is repeated, therefore I tried to modify the example so that one finds it easier to understand what the function does. Following is what I modified:

>>> _mostfunc(exp(x) + exp(exp(y) + 2), exp)
exp(exp(y) + 2)

This example would help one understand that the result also depends on the variable specified, as, if variable(3rd param) is defined it would work accordingly as given in the docs example:

>>> _mostfunc(exp(x) + exp(exp(y) + 2), exp, x)
exp(x)

[kshitij10496]

@Yathartha22 You have made a good point here.
Can you add this note on the importance of the variable (namely the parameter X) in the docstrings of _most_func for future references?

[Yathartha22]

Surely I would do it right away.

[Yathartha22]

@kshitij10496 I have added the docstring. Is it enough. Please check and let me know.

[kshitij10496]

I guess the statement can be simplified to:

If X is not None, then the function returns the term composed with the most func

[Yathartha22]

If X is not None, then the function returns the term composed with the most func having the specified variable

I think having the specified variable should also be added because even if X is None it would return the term composed with the most func.
what do you suggest?

[kshitij10496]

Yeah ! You are correct.
Kindly modify accordingly.

[Yathartha22]

Okay :)

[kshitij10496]

Typo: varaible -> variable

[smichr]

+1

[Yathartha22]

I guess I have made the necessary changes.

[kshitij10496]

+1
It would be great if you can squash these commits into a single commit.
If you don't know about rewriting history in Git, then I would suggest you use it in your next PR.

[Yathartha22]

I actually don't know how to squash but I will try to google it and find out.

[Yathartha22]

I found this:
$ git log to check for all the commits
$ git rebase -i <parent commit id>
It opens the editor showing commits; apart from the first commit replace pick to s for other commits.
It again opens the editor, put the new commit message and close editor.
$ git push -f to push the commit.

Is this the right procedure?

[ranjithkumar007]

yes, this is a right approach @Yathartha22 .

[Yathartha22]

thanks @ranjithkumar007

@kshitij10496 I squashed the commits into one. Now, is it okay?

[kshitij10496]

Awesome @Yathartha22 ! Way to go.

++1
@smichr Can we merge this now ?

[Yathartha22]

thanks @kshitij10496 :)
Also I have a question that do I have to squash every time I make more than 1 commit in a PR?

[ranjithkumar007]

@Yathartha22 , Its not the case that every time you need to squash your commits in a PR..Squashing is done to have a clear and concise git history that easily documents the changes.this in turn increases the readability of the history.So you need to do this only when the log seems to be mess.
I would also recommend to use a better commit message than rebased2 so that anyone can get a rough idea of what you have done just by reading the message.

[kshitij10496]

Thanks @ranjithkumar007
I couldn't have said it better than you did.

@Yathartha22 As @ranjithkumar007 suggested, update your commit message accordingly.

[Yathartha22]

thanks @ranjithkumar007 for the explanation and suggestion
I have made changes accordingly, have a look.

[ranjithkumar007]

+1 , looks good to me .

[smichr]

Thanks! It's in.

[Yathartha22]

Thanks @smichr for the merge
and also @kshitij10496 and @ranjithkumar007 for guidance and help. I really appreciate :)