{"id":22980986,"url":"https://github.com/rubyworks/yard-notes","last_synced_at":"2025-04-02T09:42:03.784Z","repository":{"id":1546193,"uuid":"1880015","full_name":"rubyworks/yard-notes","owner":"rubyworks","description":"If I want to know I'll ask","archived":false,"fork":false,"pushed_at":"2014-07-19T12:59:40.000Z","size":308,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-11T10:44:38.299Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rubyworks.png","metadata":{"files":{"readme":"README.md","changelog":"History.md","contributing":null,"funding":null,"license":"License.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-06-11T12:32:44.000Z","updated_at":"2014-07-19T12:56:15.000Z","dependencies_parsed_at":"2022-08-16T13:40:49.736Z","dependency_job_id":null,"html_url":"https://github.com/rubyworks/yard-notes","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fyard-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fyard-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fyard-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fyard-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rubyworks","download_url":"https://codeload.github.com/rubyworks/yard-notes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246793012,"owners_count":20834921,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-15T01:46:30.245Z","updated_at":"2025-04-02T09:42:03.758Z","avatar_url":"https://github.com/rubyworks.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# YARD Notes\n\n[Hompage](http://rubyworks.github.com/yard-notes) /\n[Report Issue](http://github.com/rubyworks/yard-notes/issues) /\n[Source Code](http://github.com/rubyworks/yard-notes) /\n[Mailing List](http://groups.google.com/groups/rubyworks-mailinglist) /\n[IRC Chat](irc://chat.us.freenode.net/rubyworks)\n\n\n## Description\n\nYARD informs us of every line in every file where a tag is used\nthat hasn't been explicitly defined. But as a programmer, if I\nused it, the it should exist. However, that doesn't mean we\nneccessiarily want all tags to show up in the docs, so this\nplugin keeps YARD from making a ruckess about tags that are \nin ALL CAPS, keeps such tags out of the docs, and adds them\nto a special NOTES pages where they can be reviewed. This is\na great way to make development notes in your code.\n\n\n## Instruction\n\nAdd ALL-CAPS tags to your doumentation. For example:\n\n\n    @TODO Need to refactor this code.\n    def some_method\n       . . .\n    end\n\n\nThe use yard as usual but add the `--plugin notes` command line\noption.\n\n    $ yard --plugin notes ...\n\n\n## Installation\n\nUsing RubyGems to install:\n\n    $ gem install yard-notes\n\n\n## Copyright \u0026 License\n\n(MIT License)\n\nCopyright (c) 2011 Rubyworks.\n\nYARD Notes is distributable under the terms of the **MIT** license.\n\nSee License.txt for details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Fyard-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frubyworks%2Fyard-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Fyard-notes/lists"}