Skip to content

Conversation

@gr8bit
Copy link
Contributor

@gr8bit gr8bit commented Jan 17, 2018

Added configuration documentation

Added configuration documentation

## Configuration

```
Copy link
Owner

Choose a reason for hiding this comment

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

Can you somehow mention what the default configuration is and where to put that file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, that's for Phoenix, sorry... will update

@gr8bit gr8bit changed the title Update README.md Configuration documentation Jan 22, 2018
@gr8bit
Copy link
Contributor Author

gr8bit commented Jan 28, 2018

Is this ok now @mweibel ? I'm preparing new PRs at the moment ;)

graph_url: "https://graph.facebook.com/v2.9",
graph_video_url: "https://graph-video.facebook.com/v2.9",
graph_url: "https://graph.facebook.com",
graph_video_url: "https://graph-video.facebook.com",
Copy link
Owner

Choose a reason for hiding this comment

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

Should we really have no version as the default configured anymore? We can increase it certainly but IMO having a sensible default seems preferable.
Also this change makes this PR a breaking change, not just a documentation change ;)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it's the right way for a library to leave (or better: force) the choice of the external api version to the user. Else we would be responsible for keeping it up to date with facebook and every update to the library could introduce incompatibilities for people who rely on the version set by the library. I'd rather have the library have no default at all (and raise if the user doesn't set any url), but I think an "eternal" url (which we don't ever need to change) is also ok in terms of easy entry to the library. True, this became more than a documentation change, sorry. ;) Your choice, you can also leave these url changes out of the merge. :)

Copy link
Owner

Choose a reason for hiding this comment

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

We have a breaking change in #58 as well, so we may as well just increase the major version after merging those two PRs.
I'd like you to next time not mix in unrelated changes to a PR (also in #58 changing the function name of set_appsecret() is such a case). Those changes can be made, but making them in a separate PR is better for visibility and to be able to accept/decline the PRs separately.

@mweibel mweibel merged commit 4283db8 into mweibel:master Feb 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants