Skip to content

Commit 73ecf8b

Browse files
committed
Fix numerous typos found with ispell
1 parent 3d16fb5 commit 73ecf8b

File tree

7 files changed

+58
-38
lines changed

7 files changed

+58
-38
lines changed

CHANGELOG.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@
4848

4949
**Fixed issues:**
5050

51-
- Fixed innacurate coverage reports via
51+
- Fixed inaccurate coverage reports via
5252
[PR \#109](https://github.com/jacobwilliams/json-fortran/pull/109)
5353
from [zbeekman](https://github.com/zbeekman)
54-
- Fixed a small consistency issue when outputing floating point
54+
- Fixed a small consistency issue when outputting floating point
5555
numbers via
5656
[PR \#125](https://github.com/jacobwilliams/json-fortran/pull/125)
5757
- Problems writing JSON to `error_unit` (0) due to JSON-Fortran's
@@ -118,7 +118,7 @@ or [Download v4.1.0](https://github.com/jacobwilliams/json-fortran/releases/tag/
118118

119119
**Enhancements:**
120120

121-
- Runtime speed improvements
121+
- Run-time speed improvements
122122
[\#75](https://github.com/jacobwilliams/json-fortran/issues/75)
123123
implemented in
124124
[PR \#93](https://github.com/jacobwilliams/json-fortran/pull/93)
@@ -180,7 +180,7 @@ or [Download v4.0.0](https://github.com/jacobwilliams/json-fortran/releases/tag/
180180
- Discrepancy with dummy argument attributes for
181181
path between `get` and `get_..._vec` procedures
182182
[\#79](https://github.com/jacobwilliams/json-fortran/issues/79)
183-
- Small bugfix for [CMake](http://www.cmake.org) install
183+
- Small bug fix for [CMake](http://www.cmake.org) install
184184
[\#68](https://github.com/jacobwilliams/json-fortran/pull/68)
185185
([zbeekman](https://github.com/zbeekman))
186186
- JSON output files from tests are overwriting expected outputs and
@@ -220,7 +220,7 @@ or [Download v3.1.0](https://github.com/jacobwilliams/json-fortran/releases/tag/
220220
from [jacobwilliams](https://github.com/jacobwilliams))
221221
- Read JSON structure from a character string
222222
[\#5](https://github.com/jacobwilliams/json-fortran/issues/5)
223-
- Adopeted official contributing guidelines and added a
223+
- Adopted official contributing guidelines and added a
224224
`CONTRIBUTING.md`
225225
[\#47](https://github.com/jacobwilliams/json-fortran/issues/47)
226226

@@ -231,11 +231,11 @@ or [Download v3.1.0](https://github.com/jacobwilliams/json-fortran/releases/tag/
231231
fixed by
232232
[PR \#54](https://github.com/jacobwilliams/json-fortran/pull/54)
233233
(from [zbeekman](https://github.com/zbeekman))
234-
- Segfaults and unexpexted behavior due to optional dummy arguments
234+
- Segfaults and unexpected behavior due to optional dummy arguments
235235
being dereferenced outside of `if (present(…))`
236236
[\#52](https://github.com/jacobwilliams/json-fortran/issues/52)
237237
- Documentation not being produced for tests because tests directory
238-
should be subdirectory of src
238+
should be sub-directory of src
239239
[\#49](https://github.com/jacobwilliams/json-fortran/issues/49)
240240
- Example 8 failing on gfortran 4.9.2
241241
[\#44](https://github.com/jacobwilliams/json-fortran/issues/44)
@@ -317,7 +317,7 @@ or [Download v2.0.0](https://github.com/jacobwilliams/json-fortran/releases/tag/
317317

318318
**Enhancements:**
319319
- Significant changes to the API including new procedures
320-
- Code refactoring
320+
- Code re-factoring
321321
- SCons build added thanks to [@bruceravel](https://github.com/bruceravel)
322322

323323
**Fixed issues:**
@@ -365,15 +365,15 @@ or [Download v2.0.0](https://github.com/jacobwilliams/json-fortran/releases/tag/
365365
[ROBODoc](https://github.com/gumpu/ROBODoc) must be specified in
366366
CMakeLists.txt manually
367367
[\#17](https://github.com/jacobwilliams/json-fortran/issues/17)
368-
- Invalid json input files (`test1.json`, `test5.json`)
368+
- Invalid JSON input files (`test1.json`, `test5.json`)
369369
[\#10](https://github.com/jacobwilliams/json-fortran/issues/10),
370370
fixed by
371371
[PR \#11](https://github.com/jacobwilliams/json-fortran/pull/11)
372372
([zbeekman](https://github.com/zbeekman))
373373
- `char()` is processor dependent, use `achar()`
374374
[\#20](https://github.com/jacobwilliams/json-fortran/pull/20)
375375
(pull request from [zbeekman](https://github.com/zbeekman))
376-
- Bugfix for [ROBODoc](https://github.com/gumpu/ROBODoc) documentation
376+
- Bug-fix for [ROBODoc](https://github.com/gumpu/ROBODoc) documentation
377377
generation with [CMake](http://www.cmake.org)
378378
[\#16](https://github.com/jacobwilliams/json-fortran/pull/16)
379379
(pull request from [zbeekman](https://github.com/zbeekman))

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to [json-fortran](README.md)
1+
# Contributing to JSON-Fortran
22

3-
Looking to contribute something to [json-fortran](https://github.com/jacobwilliams/json-fortran)? **Here's how you can help.**
3+
Looking to contribute something to [JSON-Fortran](https://github.com/jacobwilliams/json-fortran)? **Here's how you can help.**
44

55
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
66
**Table of Contents**
@@ -20,7 +20,7 @@ Looking to contribute something to [json-fortran](https://github.com/jacobwillia
2020
[top](#contributing-to-json-fortran)
2121
## Filing issues
2222

23-
- Before filing a new [issue](https://github.com/jacobwilliams/json-fortran/issues), please perform a search to see if that issue has already been filed by someone else, and whether or not a solution exists. If you are experiencing the same issue as one that's already posted, please leave any additional comments and information under the existing issue. If your issue is related to a previous issue, but substantively different, file a new issue and include a mention of the related issue in text, using GitHub's `#<issue-number>` syntax.
23+
- Before filing a new [issue](https://github.com/jacobwilliams/json-fortran/issues), please perform a search to see if that issue has already been filed by someone else, and whether or not a solution exists. If you are experiencing the same issue as one that's already posted, please leave any additional comments and information under the existing issue. If your issue is related to a previous issue, but substantively different, file a new issue and include a mention of the related issue in text, using Jib's `#<issue-number>` syntax.
2424
- When filing an issue please try to include all of the following information
2525
1. Problem description: What behavior are you seeing that you think is erroneous
2626
1. Installation method: Did you build the code with one of the included build scripts? Some other way? Install from a binary package?
@@ -53,7 +53,7 @@ Looking to contribute something to [json-fortran](https://github.com/jacobwillia
5353
- Pull requests should address one issue at a time, and each commit should be a set of self contained, related changes. If you forget something in a commit, please use `git rebase -i <ref>^` to amend and/or squash erroneous commits. Here `<ref>` is the reference to to oldest commit needing to be modified (SHA, or `HEAD~4`, etc.)
5454
- Each commit should compile, and ideally pass the tests. Very complicated new features or fixes, may have commits that don't pass tests, if otherwise the commit history would include far to many changes in any given commit. Use an interactive rebase to fix any of these issues, as described above.
5555
- Each commit should have a concise, descriptive message following the
56-
guidlines laid out
56+
guidelines laid out
5757
[here](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
5858
- Make sure to document your changes in the
5959
[CHANGELOG](https://github.com/jacobwilliams/json-fortran/blob/master/CHANGELOG.md)
@@ -73,7 +73,7 @@ git rebase upstream/master
7373
- Create a branch in your fork with a descriptive name that also includes the [issue number](https://github.com/jacobwilliams/json-fortran/issues), if applicable. For example, after forking the repo, you can run something like `git checkout -b Unicode-support-issue-35` before starting work on [issue #35 : Unicode support](https://github.com/jacobwilliams/json-fortran/issues/35)
7474
- When you're content with your changes, your commits are clean, self contained, with concise descriptive messages, and your changes compile and pass the tests, submit a pull request. We will review your changes, and may ask for certain modifications to be made.
7575
- Pull requests are tested by our [travis-ci](https://travis-ci.org/jacobwilliams/json-fortran) continuous integration system, and any errors uncovered will need to be fixed before the pull request can be merged into master.
76-
- The json-fortran library and associated documentation is released under a BSD style [license](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE). By submitting a pull request, you are agreeing to release your code under the same license. Note that code with GPL or other "copyleft" style licenses will not be accepted.
76+
- The JSON-Fortran library and associated documentation is released under a BSD style [license](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE). By submitting a pull request, you are agreeing to release your code under the same license. Note that code with GPL or other "copyleft" style licenses will not be accepted.
7777

7878
[top](#contributing-to-json-fortran)
7979
## Coding Standards
@@ -87,7 +87,7 @@ git rebase upstream/master
8787
- New tests are added to the `src/tests` directory and are named
8888
`jf_test_<#>.[Ff]90`. Each test is a stand alone Fortran program
8989
which will automatically be compiled and linked against the
90-
json-fortran library so long as it follows this naming
90+
JSON-Fortran library so long as it follows this naming
9191
convention. If any of the tests fail, the test program should exit
9292
with a non-zero return status, using the `stop 2` intrinsic
9393
statement. (The Fortran standard does not require the 'processor' to
@@ -99,6 +99,6 @@ git rebase upstream/master
9999
- *Do NOT* allow your editor to make a bunch of indentation or white space changes, that will introduce non-substantive changes on lines that you have not actually edited.
100100
- The coding style is modern free-form Fortran, consistent with the Fortran 2008 standard. Note that the two supported compilers (ifort and gfortran) do not currently include the entire Fortran 2008 standard. Therefore, only those language features supported by Gfortran 4.9 and Intel 13.1.0 are currently allowed. This also means that previous versions of these compilers are not supported, and major changes to the code to support earlier compilers (or Fortran 95) will not be accepted. At some point in the future (when compiler support has improved), all Fortran 2008 features will be allowed.
101101
- All subroutines and functions *must* be properly documented. This includes useful inline comments as well as comment blocks using the [FORD](https://github.com/cmacmackin/ford/wiki/Writing-Documentation) syntax.
102-
- For simplicity, json-fortran currently consists of one module file. It is not envisioned that it will ever need to expand to include multiple files (if it does, there would need to be a very good reason).
102+
- For simplicity, JSON-Fortran currently consists of one module file. It is not envisioned that it will ever need to expand to include multiple files (if it does, there would need to be a very good reason).
103103

104104
[top](#contributing-to-json-fortran)

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
json-fortran
1+
JSON-Fortran
22
============
33

44
[![GitHub release](https://img.shields.io/github/release/jacobwilliams/json-fortran.svg?style=plastic)](https://github.com/jacobwilliams/json-fortran/releases/latest)
@@ -7,12 +7,12 @@ A Fortran 2008 JSON API
77
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
88
**Table of Contents**
99

10-
- [json-fortran](#json-fortran)
10+
- [JSON-Fortran](#json-fortran)
1111
- [Status](#status)
1212
- [Brief description](#brief-description)
1313
- [Download](#download)
1414
- [Building the library](#building-the-library)
15-
- [Exapmle Usage](#exapmle-usage)
15+
- [Example Usage](#example-usage)
1616
- [Reading JSON from a file](#reading-json-from-a-file)
1717
- [Reading JSON from a string](#reading-json-from-a-string)
1818
- [Modifying variables in a JSON file](#modifying-variables-in-a-json-file)
@@ -135,7 +135,7 @@ endforeach()
135135

136136
[top](#json-fortran)
137137

138-
Exapmle Usage
138+
Example Usage
139139
---------------
140140
In this section the basic functionality of the JSON-Fortran library is illustrated.
141141

pages/development-resources/index.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,14 @@ JSON-Fortran contributors and developers.
55

66
# Contributing
77

8-
The guidlines for contributing to JSON-Fortran can be found
8+
The guidelines for contributing to JSON-Fortran can be found
99
[here](CONTRIBUTING.html). Please read these before posting
1010
[issues](https://github.com/jacobwilliams/json-fortran/issues)
1111
or opening
12-
[pull requests](https://github.com/jacobwilliams/json-fortran/pulls).
12+
[pull requests](https://github.com/jacobwilliams/json-fortran/pulls). Also,
13+
please carefully read the
14+
[LICENSE](|url|/page/development-resources/LICENSE.html) before using
15+
JSON-Fortran in an application, or contributing code.
1316

1417

1518
# Test Coverage Information
@@ -21,3 +24,20 @@ automatically generated by
2124
[FoBiS.py](https://github.com/szaghi/FoBiS). If all procedures are
2225
listed as covered, then please take a look at the
2326
[Codecov.io coverage suggestions](https://codecov.io/github/jacobwilliams/json-fortran/features/suggestions?ref=master).
27+
28+
# Scripts
29+
30+
Scripts used to build and test JSON-Fortran. This is a partial list of
31+
scripts used in building and testing JSON-Fortran, as well as
32+
deploying documentation and managing test coverage information.
33+
34+
- [`build.sh`](build.sh.html)
35+
- [`.travis.yml`](travis.yml.html)
36+
- [`deploy.sh`](deploy.sh.html)
37+
- [`gccr.pl`](gccr.pl.html)
38+
39+
# Release Checklist
40+
41+
[This](|url|/page/development-resources/release-checklist.html) is a
42+
checklist of tasks to be performed when tagging a new release of
43+
JSON-Fortran. The current stable version is **{!__VERSION__!}**.

pages/development-resources/release-checklist.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@ title: Release Checklist
22

33
When tagging a new release please follow this checklist so that the
44
documentation will be updated correctly, and version strings will
5-
remain accuracte.
5+
remain accurate.
66

77
# Release Checklist
88

99
1. Make sure you are working from the master branch: `git checkout master`
1010
1. Update the `CHANGELOG.md`
1111
1. Ensure that the changes listed under
12-
[Unreleased](|url|/page/releases/index.html#Unreleased) are up
12+
[Unreleased](|url|/page/releases/index.html#unreleased) are up
1313
to date and accurate.
14-
1. Look at the latest [changes commited to GitHub since the
14+
1. Look at the latest [changes committed to GitHub since the
1515
last release](https://github.com/jacobwilliams/json-fortran/compare/{!__VERSION__!}...HEAD),
1616
{!__VERSION__!}. This will only be accurate if you have
1717
not yet updated `__VERSION__`. If you *have* updated
@@ -20,11 +20,11 @@ remain accuracte.
2020
1. Run the
2121
[`github_changelog_generator`](https://github.com/skywinder/github-changelog-generator)
2222
as follows, and compare the output to the
23-
[Unreleased](|url|/page/releases/index.html#Unreleased)
23+
[unreleased](|url|/page/releases/index.html#unreleased)
2424
section of the `CHANGELOG.md`:
2525
`github_changelog_generator -o Unreleased.md
2626
--unreleased-only --bugs-label "**Fixed issues:**"
27-
--enhancement-lable "**Enhancements:**" --issues-lable
27+
--enhancement-label "**Enhancements:**" --issues-label
2828
"**Fixed issues:**"` and make sure that you have a
2929
16-digit GitHub token stored in the environment variable
3030
`CHANGELOG_GITHUB_TOKEN`. Compare generated
@@ -47,7 +47,7 @@ remain accuracte.
4747
1. Add an entry in `pages/releases/index.md` under the "Past
4848
Releases" heading
4949
1. Copy/paste the most recent one listed and replace all
50-
occurences of the old version string with the new version
50+
occurrences of the old version string with the new version
5151
string
5252
1. Add `pages/releases/index.md` to the git index: `git add pages/releases/index.md`
5353
1. Update the version string in remaining files requiring manual edits:
@@ -57,8 +57,8 @@ remain accuracte.
5757
README.md`
5858
1. Commit the changes to the master branch: `git commit`
5959
1. Create the tag: `git tag <new version>`
60-
1. [deploy.sh](|url|/page/development-resources/deploy.sh.html) will
61-
publish the documentation for the latest tag from
60+
1. [deploy.sh](deploy.sh.html) will publish the documentation for the
61+
latest tag from
6262
[Travis-CI](https://travis-ci.org/jacobwilliams/json-fortran) to
6363
https://jacobwilliams.github.io/json-fortran/<version>/ if all
6464
goes according to plan
@@ -74,7 +74,7 @@ remain accuracte.
7474
1. Add your fork as a pushable remote: `git remote add
7575
YOUR_USERNAME https://github.com/YOUR_USERNAME/homebrew.git`
7676
1. Make sure you're on the master branch: `git checkout master`
77-
1. Make sure eveything is up to date: `brew update` (this calls
77+
1. Make sure everything is up to date: `brew update` (this calls
7878
`git pull`)
7979
1. Create a new branch from the latest master branch with `git
8080
checkout -b YOUR_BRANCH_NAME origin/master`
@@ -84,7 +84,7 @@ remain accuracte.
8484
checksum at the top of the formula. These should be changed to
8585
correspond to the new version of the compressed tarball
8686
available on newly minted
87-
[latest releaase page](https://github.com/jacobwilliams/json-fortran/releases/latest)
87+
[latest release page](https://github.com/jacobwilliams/json-fortran/releases/latest)
8888
1. Test the changes to make sure that they will be accepted:
8989
1. `brew audit --strict --online json-fortran`
9090
1. `brew rm json-fortran`

pages/development-resources/travis.yml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ This is the
55
used to perform continuous integration testing for JSON-Fortran, and
66
trigger automatic documentation deployment.
77

8-
```YAML
8+
```yml
99
{!.travis.yml!}
1010
```

pages/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ title: Additional Documentation
66

77
# Past Releases
88

9-
Docementation for official, tagged releases can be found
9+
Documentation for official, tagged releases can be found
1010
[here](releases/index.html), including the changelog, and download links.
1111

12-
# DeveLopment Documentation
12+
# Development Documentation
1313

1414
Additional documentation useful to JSON-Fortran contributors can be
15-
found [here](development-resources/index.html), including contributing guidlines
15+
found [here](development-resources/index.html), including contributing guidelines
1616
and test coverage reports.
1717

1818
# General Documentation
1919

2020
A [README](README.html), the same one that's posted on
21-
[Github](https://github.com/jacobwilliams/json-fortran), can be found
21+
[GitHub](https://github.com/jacobwilliams/json-fortran), can be found
2222
[here](README.html).

0 commit comments

Comments
 (0)