Skip to content

DOC: Clean up docs for io.data.Options. #7484

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 1 commit into from
Jun 17, 2014

Conversation

davidastephens
Copy link
Contributor

Per conversation on #5602, adjusted some of the docs.
Removed from release.rst, changed example strike price for AAPL, fixed backticks.

@davidastephens
Copy link
Contributor Author

@jreback
Copy link
Contributor

jreback commented Jun 17, 2014

@jorisvandenbossche wondering if should somehow limit the columns so the display is not so wide...

?

@jreback jreback added the Docs label Jun 17, 2014
@jreback jreback added this to the 0.14.1 milestone Jun 17, 2014
@davidastephens
Copy link
Contributor Author

We could do that - maybe cut it off at volume so it doesn't wrap?

The downside being that you wouldn't see all the available information that is downloaded - ie: open int, underlying price, quote time, etc. We could add that detail in the text.

@jreback
Copy link
Contributor

jreback commented Jun 17, 2014

the doc-string is pretty comprehensive, this is just an example

@davidastephens
Copy link
Contributor Author

Good point. Changed it to show only to volume.

jreback added a commit that referenced this pull request Jun 17, 2014
DOC: Clean up docs for io.data.Options.
@jreback jreback merged commit fd677ae into pandas-dev:master Jun 17, 2014
@jorisvandenbossche
Copy link
Member

@jreback we could set pd.options.display.max_columns to a lower number, but otherwise, for the docs maybe better the user sees the same thing when they try it out themselves.

@jreback
Copy link
Contributor

jreback commented Jun 17, 2014

no that's ok, only thing may want to revist the screen width in general in the docs? shouldn't it be larger?

@jorisvandenbossche
Copy link
Member

We have had that discussion before #4165, I think in the first place we should make our examples so that the output is not too wide.

@jorisvandenbossche
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants