update docs to reflect '--args=values' #562

Closed
minrk opened this Issue Jul 7, 2011 · 6 comments

Comments

Projects
None yet
2 participants
Owner

minrk commented Jul 7, 2011

By popular demand, traditional '--args=values' is restored in master. The docs should be updated to reflect this, because we should probably remove support for the 'args=values' in 0.12. The only reason it will be supported in 0.11 is rc1 made it into EPD this week, but our docs should not reflect this pattern that won't stick.

Owner

minrk commented Jul 8, 2011

@takluyver - do you have time to skim docs (and usage.py, etc.), and update command-line arguments? Anything that is 'foo=bar' should be '--foo=bar', (even full Class.trait=value should be --Class.trait=value). interactive/reference will be one of the main targets, as well as config/overview.

Owner

takluyver commented Jul 8, 2011

I'll see what I can do this evening.

Owner

takluyver commented Jul 8, 2011

@minrk: While I'm going through it, the note at the top of this page looks like a developer TODO. Can we either remove it or make it clearer for users?

http://ipython.org/ipython-doc/dev/parallel/parallel_mpi.html

Owner

takluyver commented Jul 8, 2011

Also, I'm seeing a few references to FURL files (e.g. in the parallel security docs). Am I right in thinking that the JSON files have replaced FURL files?

Owner

minrk commented Jul 8, 2011

@takluyver, I believe the mpi doc is now up to date, you can remove the note.

Nothing starting with 'Other Questions' applies to zmq in the security doc, so should probably be removed, thanks.

Owner

takluyver commented Jul 8, 2011

Closed by merge 2952bd3

@takluyver takluyver closed this Jul 8, 2011

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment