Skip to content

[WIP] Add tutorial for LogScale #11250

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

souravsingh
Copy link
Contributor

@souravsingh souravsingh commented May 15, 2018

PR Summary

#8863

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@jklymak
Copy link
Member

jklymak commented May 16, 2018

Thanks @souravsingh, but I think this is a little basic for a tutorial. Maybe move into the examples?

@jklymak jklymak added this to the v3.0 milestone May 16, 2018
@timhoffm
Copy link
Member

So far, this is just a minor rewrite of the existing log demo. C.f.

existing log demo
this PR

@souravsingh I assume you are going to expand on this. OTOH there's no need to open a PR in this early stage. PRs should be opened when the feature is either complete or if you need feedback on certain aspects before completion.

@souravsingh
Copy link
Contributor Author

@timhoffm Yes, It is a minor rewrite of the existing demo, which I intend to extend by adding tick behavior and symlog. I opened the PR early so I can get iterative feedback for the PR.

@timhoffm
Copy link
Member

timhoffm commented May 21, 2018

@souravsingh Thanks for the explanation. Please keep in mind that our review capacity is limited (actually it‘s one of the main limiting factors in the development).

That said, there is no general rule when to submit a first version. If it‘s too early, we‘re wasting reviewer time, if it‘s too late, the PR may go in the wrong direction and needs correction, which is extra work for the author. As a rule of thumb, a PR does not have to be polished, if you are having doubts. But in that case, it should at least demonstrate your ideas. Also, it helps a lot, if you your ideas and indicate the state of the changes.

We‘re happy to give feedback once this is more concrete.

@souravsingh
Copy link
Contributor Author

Closing the PR since there is zero incentive for me in working on this.

@timhoffm
Copy link
Member

@souravsingh I hope we don't have scared you off with our comments. Helping to improve the documentation is greatly apreciated.

Of course, the motivation has to come from within yourself. We can only give feedback and help along the way. I recognize that priorities and motivation can change, and that's perfectly fine. Maybe see you another time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants