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

Updated developer documenation #2951

Merged
merged 7 commits into from Mar 20, 2019

Conversation

Projects
None yet
6 participants
@nabobalis
Copy link
Contributor

commented Mar 3, 2019

Description

This is part 1 of the epic journey that is, "Nabil goes over all the files in SunPy".

Merged in #2934
Fixes #2931
Fixes #2925
Fixes #1858
Fixes #856
Fixes #1618
Fixes #212

CONTRIBUTING.rst is the one to check the most

The other changes are mainly within the dev_guide section that hopefully explain more about our test suite and how to write/run aspects of SunPy

Built docs.

@nabobalis nabobalis added this to the 1.0 milestone Mar 3, 2019

@pep8speaks

This comment has been minimized.

Copy link

commented Mar 3, 2019

Hello @nabobalis! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2019-03-20 21:03:11 UTC
@sunpy-bot

This comment has been minimized.

Copy link

commented Mar 3, 2019

Thanks for the pull request @nabobalis! Everything looks great!

@sunpy sunpy deleted a comment from sunpy-bot bot Mar 3, 2019

@sunpy sunpy deleted a comment from sunpy-bot bot Mar 3, 2019

@sunpy sunpy deleted a comment from sunpy-bot bot Mar 3, 2019

@nabobalis nabobalis force-pushed the nabobalis:dev_docs branch from b7afcfb to 36ac8e6 Mar 3, 2019

Show resolved Hide resolved tox.ini Outdated

@nabobalis nabobalis force-pushed the nabobalis:dev_docs branch 2 times, most recently from 208b0c6 to c0aa088 Mar 4, 2019

@nabobalis

This comment was marked as outdated.

Copy link
Contributor Author

commented Mar 4, 2019

There are enough changes in this PR that I won't correct the issues I spot with the API docs until PR number 2.

@nabobalis nabobalis force-pushed the nabobalis:dev_docs branch 3 times, most recently from c994468 to 2562438 Mar 4, 2019

@nabobalis nabobalis force-pushed the nabobalis:dev_docs branch 3 times, most recently from 1f88eac to 448db99 Mar 5, 2019

@nabobalis

This comment was marked as outdated.

@nabobalis nabobalis force-pushed the nabobalis:dev_docs branch 2 times, most recently from 4b02a25 to c7f7c73 Mar 7, 2019

Show resolved Hide resolved docs/code_ref/io.rst Outdated
Show resolved Hide resolved CONTRIBUTING.rst Outdated
Show resolved Hide resolved CONTRIBUTING.rst Outdated
Show resolved Hide resolved CONTRIBUTING.rst
Show resolved Hide resolved CONTRIBUTING.rst
Show resolved Hide resolved docs/dev_guide/code_standards.rst

@nabobalis nabobalis force-pushed the nabobalis:dev_docs branch from c7f7c73 to 7a55211 Mar 14, 2019

@Cadair

Cadair approved these changes Mar 16, 2019

Copy link
Member

left a comment

I wont pretend to have gone through all this line-by-line but I think it's easy to see it's an improvement on what we have at the moment. I think the contributing.rst is very good (that I did read all of).

@Cadair

Cadair approved these changes Mar 20, 2019

@nabobalis nabobalis force-pushed the nabobalis:dev_docs branch from 316cff7 to 95d3b48 Mar 20, 2019

@nabobalis

This comment has been minimized.

Copy link
Contributor Author

commented Mar 20, 2019

I'm gonna merge this in now and if any problems arise, we can fix them after.

@nabobalis nabobalis merged commit 9fcadf7 into sunpy:master Mar 20, 2019

10 of 13 checks passed

ci/circleci: html-docs Your tests failed on CircleCI
Details
sunpy.sunpy Build #20190320.27 has test failures
Details
sunpy.sunpy (Linux_37_online) Linux_37_online failed
Details
ci/circleci: 32bit Your tests passed on CircleCI!
Details
ci/circleci: egg-info-36 Your tests passed on CircleCI!
Details
ci/circleci: egg-info-37 Your tests passed on CircleCI!
Details
ci/circleci: figure-tests-36 Your tests passed on CircleCI!
Details
ci/circleci: pip-install Your tests passed on CircleCI!
Details
sunpy-bot All checks passed
sunpy.sunpy (Linux_36_Conda_offline) Linux_36_Conda_offline succeeded
Details
sunpy.sunpy (Linux_36_offline) Linux_36_offline succeeded
Details
sunpy.sunpy (Windows_36_offline) Windows_36_offline succeeded
Details
sunpy.sunpy (macOS_37_offline) macOS_37_offline succeeded
Details

@nabobalis nabobalis deleted the nabobalis:dev_docs branch Mar 20, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.