Wikidata-Toolkit-Examples icon indicating copy to clipboard operation
Wikidata-Toolkit-Examples copied to clipboard

Updates Fetch Online Data Example for Readability & Adds JavaDoc Comments

Open horaciovelvetine opened this issue 1 year ago • 1 comments

Hey!

Been using this repo for a personal project and noticed that this example was a little bit lacking. I am a newbie to this toolkit so I'm approaching this with that naiveté - but wanted to propose these changes :)

  • Adds Java Doc comments including a list of what each example is doing
  • Refactors each of the queries into their own method for clarity and readability
  • Adds inline commenting for breadcrumbs
  • Clarifies to 4 main examples, while also including the duplicated example cases in inline comments in first 2 cases

Let me know!

horaciovelvetine avatar May 07 '24 00:05 horaciovelvetine

That last commit adding the functionality to write the results to the results dir was intended to be a separate pull request. By default it is disabled to maintain the behavior of the example, it just allows digging into the results since they can't all be read in a console meaningfully.

Happy to fix/exclude/remove that as you may see fit here, but I found it helpful when I was getting familiar!

horaciovelvetine avatar May 07 '24 03:05 horaciovelvetine