-
Notifications
You must be signed in to change notification settings - Fork 255
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
Twarc Tutorial #558
Twarc Tutorial #558
Conversation
This is looking good! |
c1928c3
to
1859476
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi Sam, thanks for sharing the tutorial. I think it covers everything with enough details and explanations! Personally, one thing I would suggest is the order of some sections, outlined below:
- Motivating example (kept as is)
- Introduction to twarc and Twitter API
- Introduction to twarc (moved from below)
- Twitter API (brief explanation of what an API is, what "endpoint" means + what can you do with the Twitter API)
- Ethical considerations when using social media data
- Ethical use of public communication data
- Copyright
- Twitter's term of service
- Setup (kept as is with the exception of Introduction to twarc which is moved up to the section above)
- "Introduction to Twitter search and counts" and other sections are kept as is
My rationale behind this structure is that it separates dev-related and ethics-related subjects into 2 sections. The Intro to twarc and Twitter API
also provides the background knowledge needed to understand the content below, so that everything from Setup onwards will focus on using the tool. What are your thoughts?
There are minor letter-casing and editorial points that I came across, but I think it makes sense to leave them til the end once the high-level structure and everything else has been finalised?
I've incorporated those suggestions, thanks! |
I've added a brief what-is-an-API section, but I struggled finding a good resource to link to for the target audience - researchers who want to understand what's going on but most likely don't need to do any coding. If anyone has a good link up their sleeve please share! |
I think the main things that are left to do are:
|
Add `pip install -e .` step to readme instructions for running local documentation server
Adds a brief overview of what an API is to the tutorial.
plus a tweak to the pandas section. This was written in collaboration with @Quiet27 and @boyd-nguyen
Fixes an error when running `mkdocs serve` for recent versions of dependencies. See mkdocstrings/mkdocstrings#436
Adds a brief paragraph about v1.1 and v2.
39d5ee8
to
52289d2
Compare
Thanks @boyd-nguyen and @mctakahashi for the screenshots, and Sam for merging :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome, hurray for the twarc tutorial! I did a content/proof-read review 😸
LGTM! Co-authored-by: Alice <[email protected]>
Awesome! This looks pretty good to me! |
We're all happy with this as a first pass! Thanks for having a look Igor. @SamHames did you want to have a final check? |
I think this is most of flow and content that I think should be included.
Outstanding items are (at least!):