https://pantsbuild.org/ logo
#development
Title
# development
h

hundreds-father-404

01/19/2022, 11:17 PM
As noted,
example-plugin
repo is horribly out of date, and also harder to follow than it needs to be. I really want to fix it, but don't have the time to Rewrite It All. What do people think about archiving what we have with a git branch, and starting over from scratch? That way we can add things back one-at-a-time. (The plugin docs already give guides for each plugin hook - this is supplemental)
b

busy-vase-39202

01/19/2022, 11:21 PM
I upvote anything that helps kickstart updating. A sparse but accurate example repo strikes me as better than a fleshed-out repo that squanders the person's time and trust by being confusingly outdated.
โž• 3
h

happy-kitchen-89482

01/19/2022, 11:23 PM
Yeah, stale documentation/examples is potentially worse than none
โž• 2
h

hundreds-father-404

01/19/2022, 11:23 PM
That's exactly what I'm thinking. Thanks! This is great, I can work on this incrementally when stuck on other projects
b

bitter-ability-32190

01/19/2022, 11:24 PM
When my PR backlog gets emptied I can volunteer some time as well
๐Ÿ™Œ 2
b

busy-vase-39202

01/19/2022, 11:40 PM
Love that teamwork!
Isn't it great when spring cleaning makes room for some exciting better thing where the clutter used to be? Hee.
๐Ÿงน 1
๐ŸŒป 1
h

hundreds-father-404

01/20/2022, 1:23 AM
We duplicate the example code in both the docs and the plugin, which has proven really hard to maintain and we often had typos with the docs code since we can't check that it runs. I'm thinking of rewriting so that most code examples are in the example repo. And we'll have multiple examples per plugin hook. Thoughts?
b

bitter-ability-32190

01/20/2022, 1:37 AM
Can you embed GitHub Gists or snippets?
c

curved-television-6568

01/20/2022, 6:10 AM
Yeah, some snippets in the docs can be really useful to help illustrate a point or example. Perhaps those pages could be generated a la the ref section (from say, sphinx docs perhaps) then the code samples can be tested during doc generation.