DOC: Cleanup dev and internals-related docs #478

Closed
wants to merge 8 commits into
from

Projects

None yet

3 participants

@vincentarelbundock
Member

No description provided.

@jseabold
Member

It looks like some of these are number of characters in a line changes? These aren't strictly necessary for sphinx. In the end I decided I preferred unbroken lines to avoid the illusion that you have control over the layout when you're putting in line breaks. Obviously not a huge deal but adds unneeded diff sets.

@josef-pkt
Member

Yes, in general I would prefer to keep pure line length editing in separate commits from text edits. otherwise, diffs are pretty useless with line oriented version control.

the git_notes changes look all like line length edits.

@josef-pkt josef-pkt commented on the diff Sep 25, 2012
docs/source/dev/dataset_notes.rst
from data import *
-If the data will be cleaned before it is in the form included in the datasets
-package then create a `nile/src` directory and include the original raw data
-there. In this case, it's not necessary.
+**Step 3**: If `nile.csv` is a transformed/cleaned version of the original data, create a `nile/src` directory and include the original raw data there. In the `nile` case, this step is not necessary.
@josef-pkt
josef-pkt Sep 25, 2012 Member

line breaks

@vincentarelbundock
Member

I apologize for this. I didn't think about it but it makes much more sense to do line breaks in separate commits. Thanks for the tip.

@josef-pkt josef-pkt referenced this pull request Sep 29, 2012
Closed

formulas missing in docs #463

@jseabold
Member

I guess I'm going to go ahead and rebase then merge after checking for any new docs build warnings. Might clean up the line breaks issue but probably won't. Any objections?

@jseabold
Member

Doesn't look like any new warnings. Going to go ahead and merge the rebased version.

@jseabold jseabold added a commit that closed this pull request Nov 13, 2012
@jseabold jseabold Merge branch 'doc_devel'. Closes #478.
* doc_devel:
  DOC: Cherry picked most of Josefs recent cleanups
  DOC: dev/git_notes.rst minor edits
  DOC: datasets
  DOC: simplify dev/examples.rst
  DOC: package_overview content split and sent to relevant files
  DOC: more precise patch submission process
  DOC: pitfalls.rst reorg
  DOC: importpaths.rst reorg
8a7dea2
@jseabold jseabold closed this in 8a7dea2 Nov 13, 2012
@PierreBdR PierreBdR pushed a commit to PierreBdR/statsmodels that referenced this pull request Sep 2, 2014
@jseabold jseabold Merge branch 'doc_devel'. Closes #478.
* doc_devel:
  DOC: Cherry picked most of Josefs recent cleanups
  DOC: dev/git_notes.rst minor edits
  DOC: datasets
  DOC: simplify dev/examples.rst
  DOC: package_overview content split and sent to relevant files
  DOC: more precise patch submission process
  DOC: pitfalls.rst reorg
  DOC: importpaths.rst reorg
1ff3a0b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment