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

Updating docs #12

Merged
merged 3 commits into from
Aug 14, 2015
Merged

Updating docs #12

merged 3 commits into from
Aug 14, 2015

Conversation

eliasdorneles
Copy link
Member

Hey folks!

So, here is my first stab at Parsel documentation.
Read the current version here: https://github.com/scrapy/parsel/blob/updating-docs/docs/usage.rst

There are still some pending things to do:

  • migrate API reference to autodocs, moving the content to docstrings in the code
  • document history of the project (origin from Scrapy selectors)
  • am I missing something?

I found interesting that the idea of Parsel and Selector ended up a bit mixed in the text, since both can be understood as "an API for parsing and querying XML/HTML documents".

What do you think?


>>> from parsel import Selector
>>> text = u"<html><body><h1>Hello, Parsel!</h1></body></html>"
>>> sel = Selector(text=text, type='html')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not so simple - what about removing type='html'?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right, I was unsure about it, but it's better, +1. :)

kmike added a commit that referenced this pull request Aug 14, 2015
@kmike kmike merged commit 94623ae into master Aug 14, 2015
@dangra dangra deleted the updating-docs branch August 14, 2015 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants