Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Improving documentation of edge cases and worthy notes #31

Open
binaryaaron opened this issue Oct 27, 2017 · 1 comment
Open

Improving documentation of edge cases and worthy notes #31

binaryaaron opened this issue Oct 27, 2017 · 1 comment

Comments

@binaryaaron
Copy link
Contributor

Per discussion on #30, I'd like to use this issue to both

  • collect cases that deserve more up-front documentation
  • propose solutions for how to show those cases to users

Simply, we can add an extra page in the sphinx docs and reference it from the home page?

@jrmontag
Copy link
Collaborator

jrmontag commented Nov 1, 2017

Adding to this list of examples. Following a conversation with @fionapigott today, I think it will be valuable to make a space for a thorough, guided tour for the user through the variations (and recommendations) in working with the "text" of a Tweet. This could possibly be in the form of a wiki on the repo, or additional docs as mentioned above.

Some specific examples of ideas that we discussed (no decisions were made, just surfacing things):

  • consider a unique (or more obvious), intentional delimiter for joining the pieces in get_all_text()
  • following some additional work integrating the outputs of the parser into a modeling pipeline, consider alternative ways of providing the end-user straightforward access to the "textual" pieces as defined in the tweet_text module

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

No branches or pull requests

2 participants