Skip to content

Conversation

@gselzer
Copy link
Member

@gselzer gselzer commented Aug 1, 2024

This PR makes the following alterations (mostly suggested by @ctrueden) to the Writing Your Own Op Package page of the documentation:

  • Moving the "Best Practices" section of the document to the top, because it really applies to all Ops
  • Reorganizing the discovery mechanisms by language, in preparation for future mechanisms operating on other languages 🪄
  • Writing a new section for explicit YAML curation (I know, it's not something we'd want to force on people, but I also don't think the YAML format is actually documented anywhere. Maybe it deserves its own page?)
  • Adding a disclaimer to the JPMS section that it will be phased out (see Convert all Op plugins from ServiceLoader to op.yaml style #140)

Original list of updates wanted by @ctrueden (I didn't really do either of these, feel free to alter this PR as you see fit!):

  • prefer Javadoc over JPMS declaration style
  • prefer @OpField for succinctness, or @OpMethod over @opclass if Op dependencies are needed, to minimize boilerplate

@gselzer gselzer requested a review from ctrueden August 1, 2024 02:46
@gselzer gselzer force-pushed the docs/update-writing-ops branch from 2fc2a00 to 7064259 Compare August 1, 2024 14:22
@hinerm hinerm force-pushed the docs/update-writing-ops branch from 7064259 to c1162ea Compare August 1, 2024 21:05
@hinerm hinerm force-pushed the docs/update-writing-ops branch from c1162ea to 3f621fa Compare August 5, 2024 16:22
@hinerm hinerm marked this pull request as ready for review August 5, 2024 16:22
@hinerm hinerm merged commit 52b6201 into main Aug 5, 2024
@hinerm hinerm deleted the docs/update-writing-ops branch August 5, 2024 16:22
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.

3 participants