{"action":"created","issue":{"url":"https://api.github.com/repos/minetest/minetest/issues/7404","repository_url":"https://api.github.com/repos/minetest/minetest","labels_url":"https://api.github.com/repos/minetest/minetest/issues/7404/labels{/name}","comments_url":"https://api.github.com/repos/minetest/minetest/issues/7404/comments","events_url":"https://api.github.com/repos/minetest/minetest/issues/7404/events","html_url":"https://github.com/minetest/minetest/issues/7404","id":328865845,"node_id":"MDU6SXNzdWUzMjg4NjU4NDU=","number":7404,"title":"Suggestions for lua_api.txt: Section numbers, empty lines, cleanup of --[[ ]] ^ -- symbols","user":{"login":"paramat","id":3686677,"node_id":"MDQ6VXNlcjM2ODY2Nzc=","avatar_url":"https://avatars0.githubusercontent.com/u/3686677?v=4","gravatar_id":"","url":"https://api.github.com/users/paramat","html_url":"https://github.com/paramat","followers_url":"https://api.github.com/users/paramat/followers","following_url":"https://api.github.com/users/paramat/following{/other_user}","gists_url":"https://api.github.com/users/paramat/gists{/gist_id}","starred_url":"https://api.github.com/users/paramat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/paramat/subscriptions","organizations_url":"https://api.github.com/users/paramat/orgs","repos_url":"https://api.github.com/users/paramat/repos","events_url":"https://api.github.com/users/paramat/events{/privacy}","received_events_url":"https://api.github.com/users/paramat/received_events","type":"User","site_admin":false},"labels":[{"id":73369122,"node_id":"MDU6TGFiZWw3MzM2OTEyMg==","url":"https://api.github.com/repos/minetest/minetest/labels/@%20Documentation","name":"@ Documentation","color":"0e8a16","default":false}],"state":"open","locked":false,"assignee":{"login":"paramat","id":3686677,"node_id":"MDQ6VXNlcjM2ODY2Nzc=","avatar_url":"https://avatars0.githubusercontent.com/u/3686677?v=4","gravatar_id":"","url":"https://api.github.com/users/paramat","html_url":"https://github.com/paramat","followers_url":"https://api.github.com/users/paramat/followers","following_url":"https://api.github.com/users/paramat/following{/other_user}","gists_url":"https://api.github.com/users/paramat/gists{/gist_id}","starred_url":"https://api.github.com/users/paramat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/paramat/subscriptions","organizations_url":"https://api.github.com/users/paramat/orgs","repos_url":"https://api.github.com/users/paramat/repos","events_url":"https://api.github.com/users/paramat/events{/privacy}","received_events_url":"https://api.github.com/users/paramat/received_events","type":"User","site_admin":false},"assignees":[{"login":"paramat","id":3686677,"node_id":"MDQ6VXNlcjM2ODY2Nzc=","avatar_url":"https://avatars0.githubusercontent.com/u/3686677?v=4","gravatar_id":"","url":"https://api.github.com/users/paramat","html_url":"https://github.com/paramat","followers_url":"https://api.github.com/users/paramat/followers","following_url":"https://api.github.com/users/paramat/following{/other_user}","gists_url":"https://api.github.com/users/paramat/gists{/gist_id}","starred_url":"https://api.github.com/users/paramat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/paramat/subscriptions","organizations_url":"https://api.github.com/users/paramat/orgs","repos_url":"https://api.github.com/users/paramat/repos","events_url":"https://api.github.com/users/paramat/events{/privacy}","received_events_url":"https://api.github.com/users/paramat/received_events","type":"User","site_admin":false}],"milestone":null,"comments":2,"created_at":"2018-06-03T21:57:34Z","updated_at":"2018-06-04T21:54:31Z","closed_at":null,"author_association":"MEMBER","body":"I want to obtain support before i do any of these since it will be a big task and will need to be merged immediately to avoid conflicts.\r\n\r\n* It is difficult to find a section, i seem to spend a lot of time searching for a section. I considered adding 'contents' to the start with line numbers, but every addition would require all line numbers to be updated.\r\nI realise we have rubenwardy's modding book which has links to sections but the lua_api file itself should be improved.\r\nSo how about a 'contents' section with a number for each section,  then in the body of the file each section title has that number added, meaning when scrolling through you can judge where the section you want is?\r\n\r\n* Double empty lines between sections will make it easier to see sections when scrolling, and add some much needed space. There can be an empty line after the title too.\r\n\r\nThe following suggestions are for the 'definitions' sections near the end:\r\n\r\n* There are many unnecessary and inconsistent '--[[ ]]' symbols around multi-line comments, creating visual clutter, i suggest removing those.\r\n\r\n* There is inconsistent usage of '^' in comments. Sometimes there is just 1 at the start of comments, sometimes 1 per new comment section, sometimes 1 per comment line.\r\n1 per line is the least clear because there is then no indentation, making it hard to spot the subject of the comment. I suggest using just 1 at the start of comments or as few as possible, as in this section:\r\nhttps://github.com/minetest/minetest/blob/5316b8fe4a5858f0307a58c0ab5630286fd573be/doc/lua_api.txt#L4966\r\n\r\n* Many comment lines have '--' embedded in the indent,  this is more visual clutter and is unnecessary, i suggest removing these. An example of clarity without is:\r\nhttps://github.com/minetest/minetest/blob/5316b8fe4a5858f0307a58c0ab5630286fd573be/doc/lua_api.txt#L5087\r\n\r\nDevs, please state support for any of these suggestions so i can work on them.\r\nTo avoid repeated work i want to do all the definitions section symbol stuff in one go, so i would appreciate all of those being supported.\r\nThe section numbers and empty lines suggestions are a somewhat independent task."},"comment":{"url":"https://api.github.com/repos/minetest/minetest/issues/comments/394512725","html_url":"https://github.com/minetest/minetest/issues/7404#issuecomment-394512725","issue_url":"https://api.github.com/repos/minetest/minetest/issues/7404","id":394512725,"node_id":"MDEyOklzc3VlQ29tbWVudDM5NDUxMjcyNQ==","user":{"login":"paramat","id":3686677,"node_id":"MDQ6VXNlcjM2ODY2Nzc=","avatar_url":"https://avatars0.githubusercontent.com/u/3686677?v=4","gravatar_id":"","url":"https://api.github.com/users/paramat","html_url":"https://github.com/paramat","followers_url":"https://api.github.com/users/paramat/followers","following_url":"https://api.github.com/users/paramat/following{/other_user}","gists_url":"https://api.github.com/users/paramat/gists{/gist_id}","starred_url":"https://api.github.com/users/paramat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/paramat/subscriptions","organizations_url":"https://api.github.com/users/paramat/orgs","repos_url":"https://api.github.com/users/paramat/repos","events_url":"https://api.github.com/users/paramat/events{/privacy}","received_events_url":"https://api.github.com/users/paramat/received_events","type":"User","site_admin":false},"created_at":"2018-06-04T21:54:31Z","updated_at":"2018-06-04T21:54:31Z","author_association":"MEMBER","body":"Anyway, we can move forward with sections and subsections, i suggest numbers plus letters for these."}}
{"actor":{"display_login":"paramat"}}