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

Make documentation for cusip_cik_exceptions and handle_cusip_cik_exceptions.ipynb #97

Open
bdcallen opened this issue Sep 1, 2020 · 2 comments
Assignees
Labels

Comments

@bdcallen
Copy link
Contributor

bdcallen commented Sep 1, 2020

@iangow This issue is for making documentation for edgar.cusip_cik_exceptions, explaining what it's for and what its fields are, how I made the initial table, and how one can maintain it using handle_cusip_cik_exceptions.ipynb.

@bdcallen bdcallen self-assigned this Sep 1, 2020
bdcallen added a commit that referenced this issue Sep 1, 2020
bdcallen added a commit that referenced this issue Sep 1, 2020
bdcallen referenced this issue Sep 23, 2020
- Updated handle_cusip_cik_exceptions.ipynb
@bdcallen
Copy link
Contributor Author

@iangow Ok, I've made a first draft of the readme cusip_cik_exceptions.md. I have alse cleaned up handle_cusip_cik_exceptions.ipynb, and added a bunch of markdown cells to it to make it feel more like a notebook with some documentation. The markdown cells further down in the notebook admittedly become a bit terse, which is intentional since the writing needed starts to become a bit repetitive (users can see what's going on by looking at the cells with the code). Let me know what you think. If you're happy with the way things currently are, I think we can close this issue.

@iangow iangow added the defer label Oct 18, 2020
@iangow
Copy link
Member

iangow commented Oct 18, 2020

Let's put this on the defer list.

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

No branches or pull requests

2 participants