-
Notifications
You must be signed in to change notification settings - Fork 61
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
Fix warnings in codegen configuration documentation #125
Fix warnings in codegen configuration documentation #125
Conversation
@mt00chikin: Thank you for submitting a pull request! Before we can merge it, you'll need to sign the Apollo Contributor License Agreement here: https://contribute.apollographql.com/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for fixing these warnings @mt00chikin. There are a lot of documentation changes in here that haven't gone out in a release yet though. The reason for that is the documentation is built as soon as the PR is merged whereas releases are from a tag.
So to fix this:
- Create a new branch from the
1.7.0
tag, - Redo your edits to
ApolloCodegenConfiguration
, - Re-generate the documentation
That should include only the fixes to the codegen configuration and not the other stuff we haven't released yet - thanks.
You'll have to end up force pushing if you keep this branch name or just close this PR and create an entirely new one. |
No prob. Thanks for the info! I was wondering why the documentation was so different on my branch, that explains it. I'll try to get this updated soon. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much for this! And good catch @calvincestari. We'll get this in as soon as you push the update!
99ff51f
to
1996958
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for pushing the update @mt00chikin, it's a more concise diff now - thanks.
10a0738e Fix warnings in codegen configuration documentation (#125) git-subtree-dir: apollo-ios-codegen git-subtree-split: 10a0738e7139125ddeff9ebd91fc6887da4fbfb0
…ration documentation git-subtree-dir: apollo-ios-codegen git-subtree-mainline: 84c0392 git-subtree-split: 10a0738e7139125ddeff9ebd91fc6887da4fbfb0
No prob! I saw that a test failed, but I noticed that my change has an invalid reference 🤦 I'm gonna fix it and get one more commit up |
Or not ;) |
The failed test was in the pagination module though and didn't look related to the docs change. So I merged it anyways. |
Sounds good. I accidentally left the old CaseConversionStrategy in the path for the EnumCases header doc. |
ApolloCodegenConfiguration's documentation had invalid references, which was causing the GenerateDocumentation command to fail.
The header docs were pointing to EnumCase and were missing an additional path component. This fixes those invalid references and re-generates the documentation.
Current state:
Updated: