)]}'
{
  "commit": "6a16d7d95259a25874f6dd6f37ae709325229a16",
  "tree": "e5fcf010d0c8deb3ba9437a43e4c7ce2676a1576",
  "parents": [
    "6a0bad4e589d158c409b50238f51c4d6868bc230"
  ],
  "author": {
    "name": "Marc Kupietz",
    "email": "kupietz@ids-mannheim.de",
    "time": "Mon Aug 31 21:36:01 2026 +0200"
  },
  "committer": {
    "name": "Marc Kupietz",
    "email": "kupietz@ids-mannheim.de",
    "time": "Mon Aug 31 21:36:03 2026 +0200"
  },
  "message": "Document KorAPConnection() as a function to fix CRAN Rd NOTE\n\nCRAN\u0027s r-devel-linux-x86_64-debian-gcc and -clang checks report\n\n  Rd files without \\usage:\n    \u0027KorAPConnection-class.Rd\u0027\n  \\arguments should not be documented without \\usage.\n\nbecause the user facing documentation, with one @param per constructor\nargument, was attached to the setClass() call. The object exported under\nthe name KorAPConnection was the class generator, whose formals are just\n`function(...)`, so roxygen2 could not derive a \\usage section from it\nand the documented arguments ended up in an Rd file without one. Adding\na hand written \\usage is not an option either: it contradicts the\ngenerator\u0027s `...` signature and turns the NOTE into a much worse\n\"code/documentation mismatches\" WARNING.\n\nReplace the generator with a real KorAPConnection() function that\nforwards its arguments to new(\"KorAPConnection\", ...) and attach the\ndocumentation to it. roxygen2 now derives \\usage from the actual\nformals, so the manual page states how the constructor is really called,\nand the NOTE is gone.\n\nThe constructor forwards supplied arguments only, so that the defaults\nand the missing() based KORAP_VERBOSE / rkorap.verbose overrides of the\ninitialize method keep working unchanged. Its own defaults merely mirror\nthose of the initialize method in order to document them; the new tests\nasserts that the documented defaults are the ones a connection actually\nends up with, so that the two cannot drift apart silently. The KORAP_URL\ndefault is now shared by both signatures as defaultKorAPUrl().\n\nNAMESPACE is unchanged: KorAPConnection remains both an exported\nfunction and an exported S4 class, and new(\"KorAPConnection\", ...) keeps\nworking.\n\nR CMD check --as-cran: Status OK, and no Rd file in man/ has \\arguments\nwithout \\usage any more.\n\nCo-Authored-By: Claude Opus 5 \u003cnoreply@anthropic.com\u003e\nChange-Id: I789d42c01e1be98a989f8f4d9a5b14865ca48daa\n",
  "tree_diff": [
    {
      "type": "modify",
      "old_id": "f7b6af87bfe508cb2571374f3bb7b03427169ad9",
      "old_mode": 33188,
      "old_path": "R/KorAPConnection.R",
      "new_id": "967feaa7bc4121ffc304c0c1f665e3c597f46323",
      "new_mode": 33188,
      "new_path": "R/KorAPConnection.R"
    },
    {
      "type": "rename",
      "old_id": "fd306a40d6fba3ea1b8ffe8adcbf0df3d2eee8fe",
      "old_mode": 33188,
      "old_path": "man/KorAPConnection-class.Rd",
      "new_id": "018573fe87775a7b4834f195f156f1553eb046df",
      "new_mode": 33188,
      "new_path": "man/KorAPConnection.Rd",
      "score": 93
    },
    {
      "type": "add",
      "old_id": "0000000000000000000000000000000000000000",
      "old_mode": 0,
      "old_path": "/dev/null",
      "new_id": "5da491565a7d39b4a205555720c67e3d1803a5e2",
      "new_mode": 33188,
      "new_path": "man/defaultKorAPUrl.Rd"
    },
    {
      "type": "modify",
      "old_id": "35a92a05835bfb320676f6a692118a3a7e9d1b79",
      "old_mode": 33188,
      "old_path": "man/initialize-KorAPConnection-method.Rd",
      "new_id": "8399c3fb2b90f2623a5f7d83a754e8750a899e54",
      "new_mode": 33188,
      "new_path": "man/initialize-KorAPConnection-method.Rd"
    },
    {
      "type": "add",
      "old_id": "0000000000000000000000000000000000000000",
      "old_mode": 0,
      "old_path": "/dev/null",
      "new_id": "e8356fe2d5b614356424f4eb6ae3803234690847",
      "new_mode": 33188,
      "new_path": "tests/testthat/test-korapconnection-signature.R"
    }
  ]
}
