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

Already on GitHub? Sign in to your account

Draft blog post for version 0.16.2 #58

Merged
merged 7 commits into from
Jun 27, 2017
Merged

Draft blog post for version 0.16.2 #58

merged 7 commits into from
Jun 27, 2017

Conversation

jbarnoud
Copy link
Contributor

No description provided.


Just a few weeks after our last release, we are releasing MDAnalysis version
0.16.2. The [release notes][notes] list the full details of the changes in this
version. Like the previous one, this release is dedicated to fixing bugs. It
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't say it's dedicated to bug fixes, the point of it is the deprecations and we need to be loud about this

[`MDAnalysis.analysis.base.analysis_class`][analysis_class] function can be
used to replace the deprecated `Timeseries`.

Quick selectors are also deprecated and will be removed in version 1.0. You can
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably best to give examples of what these are and how to replace them

Finally, the global [flags][] will disappear in version 1.0 to be replaced with
more granular keyword arguments in the appropriate methods.

Removing outdated code allows us to keep MDAnalysis robust and consistent. We
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.. as we prepare for 1.0 where features will become frozen

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The interface is going to be frozen. We will hopefully add features.

Copy link
Member

@richardjgowers richardjgowers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for starting this @jbarnoud , I've added some comments, but I might have time to get to them myself later

@jbarnoud
Copy link
Contributor Author

I addressed a couple of comments. But what level of details should there be for the quick selector? We do not want to induce the use of them accidentally by advertising them to much in the blog post that explains there are going to disappear 😛

@richardjgowers
Copy link
Member

Ha, I guess, it's just not immediately obvious what is meant by 'quick selectors'. You could use that feature but not know what we call it.

The first feature to be deprecated is the [`Timeseries` module][timeseries]
that will be removed in version 0.17.0. The
[`MDAnalysis.analysis.base.analysis_class`][analysis_class] function can be
used to replace the deprecated `Timeseries`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a link to the old 0.16.0 blog posts showing the class would be good here.

read the discussion in [issue 1377][issue_1377] to learn how to replace the
different selectors.

Finally, the global [flags][] will disappear in version 1.0 to be replaced with
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

jbarnoud added 2 commits June 20, 2017 16:54
Add new links and describe what quick selectors are.
- link to *instant selectors* (not "quick selectors"); for all the other deprecated features we link to docs so we should also do this for instant selectors
- added a bit more justification for deprecation of instant selectors and flags
- use http://doc.mdanalysis.org for links to docs
- grammar fixes
@orbeckst
Copy link
Member

I edited the blog post through GH, please have a look, especially @richardjgowers given that you had already approved the prior version.

@kain88-de
Copy link
Member

The blog looks good to me

@kain88-de kain88-de merged commit cd02db5 into master Jun 27, 2017
@kain88-de kain88-de deleted the blog-0.16.2 branch June 27, 2017 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants