Comprehensive EDGAR overview and usage quickstart guide - #313
Open
Dzeddy wants to merge 1 commit into
Open
Conversation
This pull request significantly expands and enhances the "About" section of the secedgar documentation. The updates provide a more comprehensive introduction to both the SEC's EDGAR system and the secedgar tool, making it easier for new users to understand the context and value of the package. ### Changes include: 1. Extended introduction explaining the purpose and benefits of secedgar 2. Detailed explanation of what EDGAR is and its importance in financial reporting 3. Expanded section on how secedgar helps users interact with EDGAR data 4. New "Getting Started" section with a basic usage example 5. Improved overall structure and readability of the documentation ### Motivation The existing documentation, while informative, was quite brief. This expansion aims to: - Provide newcomers with a clearer understanding of EDGAR and its significance - Highlight the key features and benefits of using secedgar - Offer a quick-start guide to help users begin using the tool immediately - Improve the overall user experience and reduce the learning curve for new adopters ### Testing - [x] Verified all links are working correctly - [x] Ensured code example runs without errors - [x] Checked for any typos or grammatical issues - [x] Confirmed accuracy of information about EDGAR and secedgar ### Additional Notes This PR focuses on the content of the documentation. If approved, we may want to consider additional enhancements in the future, such as: - Adding more advanced usage examples - Creating a separate "Tutorials" section - Including a FAQ for common issues or questions Feedback and suggestions for further improvements are welcome!
jackmoody11
requested changes
Oct 26, 2024
|
|
||
| 1. Install the package: `pip install secedgar` | ||
| 2. Import the necessary modules in your Python script | ||
| 3. Create a `CompanyFilings` or `FilingType` object |
Member
There was a problem hiding this comment.
Suggested change
| 3. Create a `CompanyFilings` or `FilingType` object | |
| 3. Create a `CompanyFilings` and `FilingType` object |
|
|
||
| ## Getting Started with secedgar | ||
|
|
||
| To begin using secedgar, you'll typically follow these steps: |
Member
There was a problem hiding this comment.
Suggested change
| To begin using secedgar, you'll typically follow these steps: | |
| To begin using secedgar, you can follow these steps: |
Member
|
Thanks @Dzeddy! Can you accept the changes I suggested, and then I will merge? Sorry for taking a while to get back on this. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request significantly expands and enhances the "About" section of the secedgar documentation. The updates provide a more comprehensive introduction to both the SEC's EDGAR system and the secedgar tool, making it easier for new users to understand the context and value of the package.
Changes include:
Motivation
The existing documentation, while informative, was quite brief. This expansion aims to:
Testing
Additional Notes
This PR focuses on the content of the documentation. If approved, we may want to consider additional enhancements in the future, such as:
Feedback and suggestions for further improvements are welcome!
git diff upstream/master -u -- "*.py" | flake8 --diff