Documentation: Spellchecked the docs

Bug #1240207 reported by Ben Ostrowsky on 2013-10-15
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Evergreen
Undecided
Unassigned
2.3
Undecided
Unassigned
2.4
Undecided
Unassigned

Bug Description

Pushed some spellchecked versions of reports docs.

http://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/sylvar/working_branch

working/user/sylvar/working_branch

Rebuilding my git-fu, so if I've been unhelpful in this message, please let me know. Thanks!

Ben Ostrowsky (sylvar) wrote :

I have spellchecked all the docs:

http://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/sylvar/spellchecking_docs

working/user/sylvar/spellchecking_docs

The "most subtle docs bug" award goes to "il8n" (eye-ell-eight-en) instead of "i18n".

summary: - Documentation: Spellchecked the reports docs
+ Documentation: Spellchecked the docs
Remington Steed (rjs7) wrote :

Wow Ben, this is great! I looked through your changes and they all seem correct. We should make sure your fixes for the RELEASE_NOTES_NEXT files make it into the official RELEASE_NOTES_2_5 doc. I bet Kathy Lussier, Yamil or others with commit access could help with this.

What tool did you use for spellchecking? I'm sure the Documentation Interest Group (DIG) would appreciate having some recommendations to use as new docs are created.

Ben Ostrowsky (sylvar) wrote :

I'm using Notepad++ (http://notepad-plus-plus.org/) and GNU Aspell (http://aspell.net/), and a liberal application of the 'Learn' button. I figure once I'm done with this, it might be useful to commit my custom Aspell dictionary as a contrib, since:

(1) others might notice that I inappropriately approved a "word"
(2) others who would like to spellcheck their own code might be encouraged to do so if they knew they didn't have to plow through all the abbreviations found in fm_IDL.xml

Kathy Lussier (klussier) wrote :

Thanks Ben! I'll check over the 2.5 Release Note changes tomorrow. I just pushed some fixes out to the notes today. I think some of yours were caught, but I'll make sure I didn't miss anything.

Remington Steed (rjs7) wrote :

I picked this into master, and I will work on getting it into 2.4 and 2.3 docs as well.

Changed in evergreen:
milestone: none → 2.5.0
Remington Steed (rjs7) on 2013-10-22
Changed in evergreen:
milestone: 2.5.0 → 2.4.4
milestone: 2.4.4 → 2.5.0
Dan Wells (dbw2) on 2013-10-29
Changed in evergreen:
status: New → Fix Committed
Remington Steed (rjs7) wrote :

Thanks Dan for adding the milestones to this. I successfully backported the relevant portions of this branch to 2.4 and 2.3, so I will mark it as "Fix Released" for all milestones. I believe it was agreed that "Fix Released" was appropriate for committed docs changes, since they are automatically built and "released" every night.

Changed in evergreen:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers