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

Fix i18n.extra_* spelling errors in documentation. #2892

Merged
merged 1 commit into from Mar 3, 2016

Conversation

torfsen
Copy link
Contributor

@torfsen torfsen commented Mar 3, 2016

Fix several instances in the "Configuration Options" documentation where ckan.i18n.extra_* was misspelled ckan.18n.extra_* (missing i), including in example source code.

Features:

  • includes updated documentation
  • includes user-visible changes

@rossjones rossjones self-assigned this Mar 3, 2016
@rossjones
Copy link
Contributor

Went to merge this, but then checked the circle/travis tests and they were moaning about the length of the underlines for some titles. Presumably they have to have an extra 2 whatevers added to them as well.

Really appreciate the fix, but would you mind awfully fixing up the underlines? Who knew documentation could be so fussy :(

The actual message was:

Traceback (most recent call last):
  File "/usr/lib/python2.7/unittest/case.py", line 331, in run
    testMethod()
  File "/home/ubuntu/virtualenvs/venv-system/local/lib/python2.7/site-packages/nose/case.py", line 197, in runTest
    self.test(*self.arg)
  File "/home/ubuntu/ckan/ckan/tests/test_coding_standards.py", line 68, in test_building_the_docs
    "{warnings}".format(warnings=new_warnings))
AssertionError: Don't add any new warnings to the Sphinx build: 
['/home/ubuntu/ckan/doc/maintaining/configuration.rst:1609: WARNING: Title underline too short.', 
'/home/ubuntu/ckan/doc/maintaining/configuration.rst:1609: WARNING: Title underline too short.']

@torfsen
Copy link
Contributor Author

torfsen commented Mar 3, 2016

No problem -- I deserve punishment for being too lazy to run the tests on such a small change. Props to the CKAN team for ensuring a clean coding style!

I've rebased and force-pushed to keep this in a single commit.

@rossjones
Copy link
Contributor

What are circle and travis for if not to save you spending 20 minutes running tests for documentation ;)

Circle's happy, so merging. Thanks for the PR.

rossjones added a commit that referenced this pull request Mar 3, 2016
Fix `i18n.extra_*` spelling errors in documentation.
@rossjones rossjones merged commit 96938af into ckan:master Mar 3, 2016
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.

None yet

2 participants