{"id":15483403,"url":"https://github.com/hackergrrl/docstrings","last_synced_at":"2025-06-27T18:07:25.435Z","repository":{"id":57214282,"uuid":"65629336","full_name":"hackergrrl/docstrings","owner":"hackergrrl","description":"Interpret a string literal at the beginning of a function as its documentation.","archived":false,"fork":false,"pushed_at":"2016-08-15T17:28:48.000Z","size":6,"stargazers_count":16,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-18T21:18:10.366Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hackergrrl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-13T17:40:45.000Z","updated_at":"2023-09-21T20:53:56.000Z","dependencies_parsed_at":"2022-08-26T13:31:03.308Z","dependency_job_id":null,"html_url":"https://github.com/hackergrrl/docstrings","commit_stats":null,"previous_names":["noffle/docstrings"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hackergrrl/docstrings","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackergrrl%2Fdocstrings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackergrrl%2Fdocstrings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackergrrl%2Fdocstrings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackergrrl%2Fdocstrings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hackergrrl","download_url":"https://codeload.github.com/hackergrrl/docstrings/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackergrrl%2Fdocstrings/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260633731,"owners_count":23039386,"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-10-02T05:15:02.062Z","updated_at":"2025-06-27T18:07:25.411Z","avatar_url":"https://github.com/hackergrrl.png","language":"JavaScript","readme":"# docstrings\n\n\u003e Interpret a string literal at the beginning of a function as its\n\u003e documentation.\n\n\n## Usage\n\n```js\nvar doc = require('docstrings')\n\nfunction foo () {\n  \"returns foo\"\n  return 'foo'\n}\n\nconsole.log(doc(foo))\n```\n\nThis will output\n\n```\nreturns foo\n```\n\n## API\n\n```js\nvar doc = require('docstrings')\n```\n\n### doc(func)\n\nReturns a string matching the string literal at the beginning of a function.\nMatches `\"\"` and `''` literals as well as template strings.\n\n## Install\n\nWith [npm](https://npmjs.org/) installed, run\n\n```\n$ npm install docstrings\n```\n\n## Acknowledgments\n\ndocstrings was inspired by clojure's approach to documenting functions.\n\n## License\n\nISC\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackergrrl%2Fdocstrings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhackergrrl%2Fdocstrings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackergrrl%2Fdocstrings/lists"}