Skip to content
This repository has been archived by the owner on Feb 20, 2019. It is now read-only.

Fixes minor documentation issues #6

Merged
merged 1 commit into from Sep 15, 2011
Merged

Fixes minor documentation issues #6

merged 1 commit into from Sep 15, 2011

Conversation

willkg
Copy link
Member

@willkg willkg commented Sep 13, 2011

  • the docs didn't mention the repository, so doing a google search leads you
    to rfd.org but at that point, you don't know where to get the code or how
    to download it or anything.
  • fixes some reST formatting issues and sphinx-docs errors
  • (cosmetic) removes an unused import in setup.py

@@ -4,22 +4,24 @@
Installation
============

Download
========
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't this be ---

Copy link
Member Author

Choose a reason for hiding this comment

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

The diff doesn't show this, but Installation is double-barred (up and down) and I was thinking "Download" and "Configure" should be subsections of "Installation". So, I think it should be ====.

Does that hierarchy make sense to have?

@davedash
Copy link
Contributor

r- good start, clean it up, rebase and I'll do another round of reviews.

* the docs didn't mention the repository, so doing a google search leads you
  to rfd.org but at that point, you don't know where to get the code or how
  to download it or anything.
* fixes some reST formatting issues and sphinx-docs errors
* (cosmetic) removes an unused import in setup.py
* tweaks some configure documentation
@willkg
Copy link
Member Author

willkg commented Sep 14, 2011

I made some more changes and amended my original commit and the force-pushed that to my fork. That seems to have updated the pull request by adding a commit, but I can't tell if that's "the right way" to modify an existing pull request.

Anyhow, r? on the new commit. If what's here is weird, I can nix this pull request and create a new one.

@davedash
Copy link
Contributor

That's the right way, IMO.

@davedash davedash closed this Sep 15, 2011
davedash added a commit that referenced this pull request Sep 15, 2011
Fixes minor documentation issues
@davedash davedash merged commit 61d617e into mozilla:master Sep 15, 2011
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants