Skip to content
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

Updates Fetch Online Data Example for Readability & Adds JavaDoc Comments #6

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

horaciovelvetine
Copy link

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!

adds a list to seperate out each use-case

adds throws and author
opted to use the Qid search to be singular with hints of getting plural resutls

opted to use the byTitle section to example getting with multiple titles to search and hints of getting singular results
- adds optional o/p to maintain minimum change to original functionality
- tighten up language for kind of Ent returned with the search functionality
- prints the results of the search func to its own file
@horaciovelvetine
Copy link
Author

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!

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.

1 participant