Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[MRG + 1] Reformat the version info and cite us labels in the user-guide docs. #8072

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

Merged
merged 2 commits into from
Dec 19, 2016

Conversation

aashil
Copy link
Contributor

@aashil aashil commented Dec 18, 2016

Reference Issue

Fixes #7021. Closes #7036.

What does this implement/fix? Explain your changes.

  • Fix the line break in the version number and make the version number bold.
  • Restructure the sentence to have "cite us" at the beginning of the line.

* Fix the line break in the version number.
* Refactor the cite us sentence to have cite us in the beginning of
  the line.
@aashil
Copy link
Contributor Author

aashil commented Dec 18, 2016

screenshot from 2016-12-17 21-21-41

{%- endif %}
<p class="citing">If you use the software, please consider <a href="{{pathto('about')}}#citing-scikit-learn">citing scikit-learn</a>.</p>
<p class="citing"><b><a href="about.html#citing-scikit-learn" style="font-size: 110%;">Cite us </a></b>if you use the software.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

seeing as this takes up 2 lines anyway (thus perhaps no harm in adding some more text), how's "Please cite us if you use scikit-learn"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree, please sounds polite.

@lesteve
Copy link
Member

lesteve commented Dec 18, 2016

@lesteve lesteve changed the title [MRG] Reformat the version info and cite us labels in the user-guide docs. [MRG + 1] Reformat the version info and cite us labels in the user-guide docs. Dec 18, 2016
@aashil
Copy link
Contributor Author

aashil commented Dec 19, 2016

I intended to display the "Other versions" link on a different line which worked with the "version 0.18" docs but according to the Circle CI link posted in the above comment, it looks to be broken out. Would you like me to put it explicitly on a new line?

I also wanted to know what are we testing on Circle CI, Appveyor and Travis CI platforms in general and the reason for having three different ones. Thanks.

@nelson-liu
Copy link
Contributor

Circleci is for building docs and doctests. Appveyor runs the unit tests on windows and TravisCI runs them on Linux + runs the lint test

@NelleV NelleV merged commit 072eefe into scikit-learn:master Dec 19, 2016
@amueller
Copy link
Member

Not sure this fully fixes the original issue. I was looking for something that has less text and pops out more. the cite us is better and now 2 lines instead of 3, but the version went from 3 lines to four. Four lines doesn't really pop.

@aashil aashil deleted the dev-reformat-version-info branch December 19, 2016 20:53
sergeyf pushed a commit to sergeyf/scikit-learn that referenced this pull request Feb 28, 2017
…ide docs. (scikit-learn#8072)

* Reformat the version info and cite us labels in the user-guide docs.

* Fix the line break in the version number.
* Refactor the cite us sentence to have cite us in the beginning of
  the line.

* Edit the sentence formation of "cite us" section.
@Przemo10 Przemo10 mentioned this pull request Mar 17, 2017
Sundrique pushed a commit to Sundrique/scikit-learn that referenced this pull request Jun 14, 2017
…ide docs. (scikit-learn#8072)

* Reformat the version info and cite us labels in the user-guide docs.

* Fix the line break in the version number.
* Refactor the cite us sentence to have cite us in the beginning of
  the line.

* Edit the sentence formation of "cite us" section.
NelleV pushed a commit to NelleV/scikit-learn that referenced this pull request Aug 11, 2017
…ide docs. (scikit-learn#8072)

* Reformat the version info and cite us labels in the user-guide docs.

* Fix the line break in the version number.
* Refactor the cite us sentence to have cite us in the beginning of
  the line.

* Edit the sentence formation of "cite us" section.
paulha pushed a commit to paulha/scikit-learn that referenced this pull request Aug 19, 2017
…ide docs. (scikit-learn#8072)

* Reformat the version info and cite us labels in the user-guide docs.

* Fix the line break in the version number.
* Refactor the cite us sentence to have cite us in the beginning of
  the line.

* Edit the sentence formation of "cite us" section.
maskani-moh pushed a commit to maskani-moh/scikit-learn that referenced this pull request Nov 15, 2017
…ide docs. (scikit-learn#8072)

* Reformat the version info and cite us labels in the user-guide docs.

* Fix the line break in the version number.
* Refactor the cite us sentence to have cite us in the beginning of
  the line.

* Edit the sentence formation of "cite us" section.
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.

Reformat version info and cite-us boxes in user guide
5 participants