graphene icon indicating copy to clipboard operation
graphene copied to clipboard

[WIP] Initial work refactoring docs/ examples/ `class Meta` to class arguments, implementing explicit imports.

Open changeling opened this issue 6 years ago • 9 comments

Refactoring firehose imports to explicit imports in docs/, examples/. Some blackening of example code in docs/. Refactoring of class Meta into class arguments.

This is a first pass of docs/ and examples/ using explicit imports and refactoring class Meta into class arguments.

Very little thought towards functionality of the documentation examples, just standardizing.

changeling avatar Jun 04 '19 08:06 changeling

Hm.. This is gonna conflict quite a bit with my docs PR.. we need to start merging these faster.. 🤔

dvndrsn avatar Jun 04 '19 11:06 dvndrsn

Oh just saw this is WIP sorry @changeling . Feel free to ignore my comments and I can give it a proper review when the PR is actually ready.

jkimbo avatar Jun 04 '19 16:06 jkimbo

Oh just saw this is WIP sorry @changeling . Feel free to ignore my comments and I can give it a proper review when the PR is actually ready.

@jkimbo Not at all! That's exactly why I made this PR/WIP. To get some more eyes on. Thanks for the feedback and review.

changeling avatar Jun 04 '19 22:06 changeling

Comment on the use of graphene. graphene. graphene. everywhere. At first I thought this was annoying and didn’t understand why it was used in the docs but I’ve got back to importing graphene types this way because they have the same name as typing types, and we try to type everything we can as it is the way python is (thankfully) headed.

On that note, is there a reason that this library doesn’t use the typing module? It would at least help new users like myself to figure out how to get things to work until this project starts moving more quickly on its various issues.

For example root, context, info — what are these things? What are the possible values or uses for them? Sans proper documentation, at least knowing what types the authors intended those arguments to accept helps tremendously.

maquino1985 avatar Jun 09 '19 11:06 maquino1985

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Aug 08 '19 15:08 stale[bot]

@changeling were you planning on updating this PR?

jkimbo avatar Aug 09 '19 18:08 jkimbo

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Oct 08 '19 18:10 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Jan 16 '20 10:01 stale[bot]

@changeling what state on 3.0?

nikitowsky avatar Jan 28 '20 14:01 nikitowsky