{"id":17160350,"url":"https://github.com/codenameyau/mini-docs","last_synced_at":"2026-02-01T22:31:33.409Z","repository":{"id":15731935,"uuid":"18470299","full_name":"codenameyau/mini-docs","owner":"codenameyau","description":"Minimal Docstrings","archived":false,"fork":false,"pushed_at":"2014-04-05T23:29:52.000Z","size":168,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-25T08:47:03.068Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"artistic-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codenameyau.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-04-05T16:01:23.000Z","updated_at":"2014-05-29T00:17:32.000Z","dependencies_parsed_at":"2022-09-10T16:11:04.073Z","dependency_job_id":null,"html_url":"https://github.com/codenameyau/mini-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/codenameyau/mini-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codenameyau%2Fmini-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codenameyau%2Fmini-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codenameyau%2Fmini-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codenameyau%2Fmini-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codenameyau","download_url":"https://codeload.github.com/codenameyau/mini-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codenameyau%2Fmini-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28993253,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-01T22:01:47.507Z","status":"ssl_error","status_checked_at":"2026-02-01T21:58:37.335Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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-14T22:24:35.197Z","updated_at":"2026-02-01T22:31:33.394Z","avatar_url":"https://github.com/codenameyau.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"mini-docs\n=========\n\n###Minimal Docstrings Convention\n\n- [Python Example](#python-example)\n- [Ruby Example](#ruby-example)\n- [C Example](#c-example)\n- [Scheme Example](#scheme-example)\n- [General Guidelines](#general-guidelines)\n\n##Python Example\n```python\n\n    def add_two_numbers(first, second):\n        \"\"\"\n        Public: (Integer, Integer) -\u003e Integer\n\n        Returns the sum of first and second.\n\n        Example:\n        \u003e\u003e add_two_numbers(2, 2) =\u003e 4\n        \"\"\"\n        pass\n\n\n    def is_number_in_list(target, numbers):\n        \"\"\"\n        Internal: (Integer, List) -\u003e Boolean\n\n        Checks if the target integer is in numbers.\n        \"\"\"\n        pass\n\n\n    def _sort_numbers(numbers):\n        \"\"\"\n        Private: (List) -\u003e List\n\n        Sorts and returns list of numbers\n        \"\"\"\n        pass\n\n\n    def deprecated_function(first, second):\n        \"\"\"\n        DEPRECATED: (Integer, Integer) -\u003e Integer\n\n        ! Use add_two_numbers() instead.\n\n        Adds the two numbers.\n        \"\"\"\n        pass\n\n```\n\n##Ruby Example\n```ruby\n\n    # Public: sum(Integer, Integer) -\u003e Integer\n    # Returns the sum of first and second\n    #\n    # Example:\n    # \u003e\u003e sum(10, 30) =\u003e 40\n    def sum(a, b)\n        return first + second\n    end\n\n```\n\n##C Example\n```c\n\n    // Public: sum(int first, int first) -\u003e int\n    // Computes the sum of first and second\n    //\n    // Example:\n    // \u003e\u003e sum(2, 4) =\u003e 6\n    int sum(int first, int second) {\n        return(first + second);\n    }\n\n```\n\n##Scheme Example\n```scheme\n\n    ;; Public: (Integer Integer) -\u003e Integer\n    ;; Returns the sum of first and second\n    ;;\n    ;; Example:\n    ;; \u003e\u003e (sum-numbers 4 5) =\u003e 9\n    (define (sum-numbers first second)\n      (+ first second))\n\n```\n\n##General Guidelines\n\n```\n\n    def descriptive_name(argument_1, argument_2):\n        \"\"\"\n        FUNCTION_USAGE: (type of argument_1, ...) -\u003e return type\n\n        FUNCTION_DESCRIPTION\n\n        EXAMPLE:\n        \"\"\"\n        ...\n\n```\n\n1. Each of the examples above have slight variations, but the overall goal is to clearly and succinctly describe the function's usage in a human readable format.\n\n2. For the function name and arguments, spell out words or use acronyms.\n    - For the function name, consider starting with a verb (ex. `add_numbers`, `send_request`)\n\n3. FUNCTION_USAGE:\n    - Choose: Public, Internal, Private, DEPRECATED\n\n4. FUNCTION_DESCRIPTION:\n    - Briefly describe what the function accomplishes. If your description is too long, consider splitting the function into smaller functions.\n\n5. EXAMPLE:\n    - Include an example if the FUNCTION_USAGE is Public. Otherwise examples are optional.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodenameyau%2Fmini-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodenameyau%2Fmini-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodenameyau%2Fmini-docs/lists"}