search

mccgr / edgar

Code to manage data related to SEC EDGAR
31 stars 15 forks source link

Create README file forms345.md #48

Closed bdcallen closed 4 years ago

bdcallen commented 5 years ago

@iangow As discussed in previous posts and emails, we wish to write some documentation for the set of code and tables pertaining to Forms 3, 4 and 5.

iangow commented 5 years ago

Perhaps put the "form345" code in a form345 subdirectory and put the documentation in readme.md in that folder.

bdcallen commented 5 years ago

@iangow I'm just wondering what the difference is between transactionDate and deemedExecutionDate is on Tables 1 and 2 on Forms 3, 4 and 5. The SEC does not really give an explicit definition for each variable in the technical guide.

iangow commented 5 years ago

If it's not obvious, just pass over that for now. One possibility would be to look for cases where they differ and see if there is a logical explanation (I assume that they are often the same, though in this case, one might be NA/NULL/None).

bdcallen commented 4 years ago

@iangow I think if you're happy with the current README, forms345.md, we should close this issue.

iangow commented 4 years ago

Sure. Good for now. Later on we might do some "user testing" of the documentation.