Enhance service documentation #27
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR does two things.
First: the discussion here makes it clear that the existing documentation on services is confusing. If I knew nothing about them and was trying to make two packages talk to one another, I would read that page and probably make the same errors that the user in that thread was making.
Second: #22 makes a lot of changes and I'm on the fence about most of them. But I figured it was a good idea to remove the least accurate information: the idea that you'll be prompted for your GitHub username and password the first time you publish. The authentication flow works differently now; I'd be tempted to include more information about it, but we do a very good job of describing the authentication process in
ppmwhen it's actually needed, so I figure it's better not to be too specific about it so that we don't have to update it in the future if we tweak the authentication flow. (If someone thinks this should go in its own PR, that's fine.)This PR also led me to reflect on a pain point I've been hitting: pulsar#1343 describes it well. I think I've got a handle on what the fix would look like and it's not as painful as I thought.
So I'm glad I was asked to explain services this morning — it led to better documentation and also to an eventual bug fix.