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

Add docs to Diffing.swift #145

Merged
merged 1 commit into from
Sep 20, 2018
Merged

Add docs to Diffing.swift #145

merged 1 commit into from
Sep 20, 2018

Conversation

benasher44
Copy link
Contributor

Changes in this pull request

Issue fixed: #143

Checklist

  • All tests pass. Demo project builds and runs.
  • I added tests, an experiment, or detailed why my change isn't tested.
  • I added an entry to the CHANGELOG.md for any breaking changes, enhancements, or bug fixes.
  • I have reviewed the contributing guide

@benasher44 benasher44 added this to the 0.3.0 milestone Sep 20, 2018
@benasher44
Copy link
Contributor Author

@jessesquires I added nodoc only for the ones that are protocol methods.

@benasher44
Copy link
Contributor Author

How do I re-gen docs?

@PlanBot-iOS
Copy link

1 Warning
⚠️ Source code changes (in APIs or behaviors) should have an entry in CHANGELOG.md.

Generated by 🚫 Danger

@jessesquires
Copy link
Collaborator

@jessesquires
Copy link
Collaborator

we should wait on the docs until we're ready to tag and release the next release, since the changes will go live immediately

@jessesquires
Copy link
Collaborator

seems like that's the plan for 0.3, so 👌

@benasher44
Copy link
Contributor Author

Ah gotcha. Usually do it post release?

@benasher44
Copy link
Contributor Author

@jessesquires good to approve this one then?

@jessesquires
Copy link
Collaborator

Usually do it post release?

I like to gen docs once everything is ready for the release, commit that, then tag the release immediately after. Feels cleaner that way, bundles everything up nicely.

good to approve this one then?

my bad! thought i accepted.

@benasher44
Copy link
Contributor Author

Ah gotcha. Sounds good!

@benasher44 benasher44 merged commit 9112718 into master Sep 20, 2018
@benasher44 benasher44 deleted the basher/diffing-docs branch September 20, 2018 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Complete docs for Diffing.swift
3 participants