Skip to content
This repository has been archived by the owner on Jan 21, 2020. It is now read-only.

Introduce a check that links that source files with documentation about them #307

Merged
merged 2 commits into from
Nov 18, 2016

Conversation

wfarner
Copy link
Contributor

@wfarner wfarner commented Nov 18, 2016

This is preparation for #305, to help us keep the yet-to-be-written docs in sync with sources.

Signed-off-by: Bill Farner bill@docker.com

Signed-off-by: Bill Farner <bill@docker.com>
@wfarner wfarner changed the title Introduce a check links source files with documentation about them Introduce a check links that source files with documentation about them Nov 18, 2016
@codecov-io
Copy link

codecov-io commented Nov 18, 2016

Current coverage is 68.97% (diff: 100%)

Merging #307 into master will increase coverage by 15.00%

@@             master       #307   diff @@
==========================================
  Files            10         27     +17   
  Lines           428       1441   +1013   
  Methods           0          0           
  Messages          0          0           
  Branches          0          0           
==========================================
+ Hits            231        994    +763   
- Misses          164        355    +191   
- Partials         33         92     +59   

Powered by Codecov. Last update 61b254a...2f58060

Copy link
Contributor

@chungers chungers left a comment

Choose a reason for hiding this comment

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

LGTM

@GordonTheTurtle
Copy link

Please sign your commits following these rules:
https://github.com/docker/docker/blob/master/CONTRIBUTING.md#sign-your-work
The easiest way to do this is to amend the last commit:

$ git clone -b "doc-check" git@github.com:wfarner/infrakit.git somewhere
$ cd somewhere
$ git rebase -i HEAD~842354643712
editor opens
change each 'pick' to 'edit'
save the file and quit
$ git commit --amend -s --no-edit
$ git rebase --continue # and repeat the amend for each commit
$ git push -f

Amending updates the existing PR. You DO NOT need to open a new one.

@wfarner wfarner merged commit abd0893 into docker-archive:master Nov 18, 2016
@wfarner wfarner changed the title Introduce a check links that source files with documentation about them Introduce a check that links that source files with documentation about them Nov 30, 2016
@wfarner wfarner deleted the doc-check branch December 1, 2016 17:51
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants