8000 DOC Outdated information on the main page of dev document? · Issue #9838 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC Outdated information on the main page of dev document? #9838

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.

Sign up for GitHub

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

Jump to bottom
Closed
qinhanmin2014 opened this issue Sep 27, 2017 · 4 comments
Closed

DOC Outdated information on the main page of dev document? #9838

qinhanmin2014 opened this issue Sep 27, 2017 · 4 comments
Labels
Documentation Moderate Anything that requires some knowledge of conventions and best practices

Comments

@qinhanmin2014
Copy link
Member

Currently, the dev page seems out of date. Is it intended?
See:
http://scikit-learn.org/dev/index.html (missing 0.18.2, 0.19.0)
2017-09-27_162216
http://scikit-learn.org/stable/index.html
2017-09-27_162232
http://scikit-learn.org/dev/documentation.html (dev seems to be 0.20? the 0.18 link is now linked to 0.19.)
2017-09-27_162535
@jnothman jnothman added Documentation Easy Well-defined and straightforward way to resolve Need Contributor labels Sep 27, 2017
@jnothman
Copy link
Member

Yes, looks like we failed to fix some of this up in the 0.19 release. I wonder if there's a way to automate it more or at least validate consistency between the different listings and version numbers...

@jnothman
Copy link
Member
jnothman commented Sep 27, 2017 via email

@jnothman
Copy link
Member

So we have three places in the docs that list previous versions of the docs:

  • index.rst
  • documentation.rst
  • themes/scikit-learn/layout.html (for the documentation menu)

I think:

  • we should use |version| or similar where possible (though I don't think it can be used in layout.html where the version number is stated)
  • we should link to the latest development and latest stable versions in documentation and in menu (perhaps we can hide these links by comparison to the URL with Javascript)
  • we should avoid referring to the latest development and latest stable versions by version number (though we can indicate that the documentation is for a stable or for a development version)
  • perhaps we should avoid referring to previous versions, and link to a "previous versions" page that can be automatically compiled by Circle
  • we should drop news from 2014 and before from NEWS.
  • ideally many of these things can be checked with a script

@jnothman jnothman added Moderate Anything that requires some knowledge of conventions and best practices and removed Easy Well-defined and straightforward way to resolve labels Sep 27, 2017
@jnothman
Copy link
Member

For layout.html, it might be possible to insert the Javascript variable DOCUMENTATION_OPTIONS.VERSION.

@jnothman jnothman added this to the 0.19.1 milestone Sep 27, 2017
@jnothman jnothman mentioned this issue Sep 27, 2017
Merged
jnothman added a commit to jnothman/scikit-learn that referenced this issue Oct 10, 2017
@jnothman
DOC fix up news in master
85a3c86 
Partial fix for scikit-learn#9838
@jnothman jnothman mentioned this issue Oct 10, 2017
Merged
@jnothman jnothman removed this from the 0.19.1 milestone Oct 16, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Moderate Anything that requires some knowledge of conventions and best practices
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jnothman @qinhanmin2014
0