{"action":"created","issue":{"url":"https://api.github.com/repos/Dallinger/Dallinger/issues/1135","repository_url":"https://api.github.com/repos/Dallinger/Dallinger","labels_url":"https://api.github.com/repos/Dallinger/Dallinger/issues/1135/labels{/name}","comments_url":"https://api.github.com/repos/Dallinger/Dallinger/issues/1135/comments","events_url":"https://api.github.com/repos/Dallinger/Dallinger/issues/1135/events","html_url":"https://github.com/Dallinger/Dallinger/issues/1135","id":341079939,"node_id":"MDU6SXNzdWUzNDEwNzk5Mzk=","number":1135,"title":"Documentation improvement proposals","user":{"login":"witekdev","id":883619,"node_id":"MDQ6VXNlcjg4MzYxOQ==","avatar_url":"https://avatars2.githubusercontent.com/u/883619?v=4","gravatar_id":"","url":"https://api.github.com/users/witekdev","html_url":"https://github.com/witekdev","followers_url":"https://api.github.com/users/witekdev/followers","following_url":"https://api.github.com/users/witekdev/following{/other_user}","gists_url":"https://api.github.com/users/witekdev/gists{/gist_id}","starred_url":"https://api.github.com/users/witekdev/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/witekdev/subscriptions","organizations_url":"https://api.github.com/users/witekdev/orgs","repos_url":"https://api.github.com/users/witekdev/repos","events_url":"https://api.github.com/users/witekdev/events{/privacy}","received_events_url":"https://api.github.com/users/witekdev/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2018-07-13T16:19:27Z","updated_at":"2018-07-13T16:20:54Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"Here are some additional comments of things we may want to include in the docs somewhere\r\nMost of these are left over from comments made on the now closed issue: https://github.com/Dallinger/Dallinger/issues/999"},"comment":{"url":"https://api.github.com/repos/Dallinger/Dallinger/issues/comments/404882250","html_url":"https://github.com/Dallinger/Dallinger/issues/1135#issuecomment-404882250","issue_url":"https://api.github.com/repos/Dallinger/Dallinger/issues/1135","id":404882250,"node_id":"MDEyOklzc3VlQ29tbWVudDQwNDg4MjI1MA==","user":{"login":"witekdev","id":883619,"node_id":"MDQ6VXNlcjg4MzYxOQ==","avatar_url":"https://avatars2.githubusercontent.com/u/883619?v=4","gravatar_id":"","url":"https://api.github.com/users/witekdev","html_url":"https://github.com/witekdev","followers_url":"https://api.github.com/users/witekdev/followers","following_url":"https://api.github.com/users/witekdev/following{/other_user}","gists_url":"https://api.github.com/users/witekdev/gists{/gist_id}","starred_url":"https://api.github.com/users/witekdev/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/witekdev/subscriptions","organizations_url":"https://api.github.com/users/witekdev/orgs","repos_url":"https://api.github.com/users/witekdev/repos","events_url":"https://api.github.com/users/witekdev/events{/privacy}","received_events_url":"https://api.github.com/users/witekdev/received_events","type":"User","site_admin":false},"created_at":"2018-07-13T16:20:54Z","updated_at":"2018-07-13T16:20:54Z","author_association":"CONTRIBUTOR","body":"I think it could be really useful to add a section on making sure you running the correct version of dalinger to http://docs.dallinger.io/en/latest/troubleshooting.html\r\n\r\n@jessesnyder explains this:\r\n\r\n> Why aren't the changes I'm making to some dallinger python file taking effect when I run an experiment??\r\n\r\nSummary\r\n---------\r\nA common pitfall while doing development on the dallinger codebase while also working on external experiments which include dallinger as a dependency: you `pip install` a demo experiment in your active virtualenvironment, and it overwrites the `dallinger.egg-link` file in that environment's `site-packages` directory with an actual copy of the `dallinger` package.\r\n\r\nDetails\r\n-------\r\nWhen installing dallinger with the intent to work **on dallinger**, the recommended way to install dallinger itself is with pip's \"editable mode\", but passing the `-e` or `--editable` flag to pip install:\r\n```\r\npip install -e .[data]\r\n```\r\nThis creates a form of symbolic link in the active python's `site-packages` directory to the working copy of dallinger you're sitting in. This allows you to make changes to python files in the dallinger working copy and have them immediately active when using `dallinger` commands or any other actions that invoke the active python interpreter.\r\n\r\nRunning `pip install` *without* the `-e` flag, either while installing dallinger directly, or while installing a separate experiment which includes dallinger as a dependency, will instead place a **copy** of the dallinger package in the `site-packages` directory. These files will then be executed when the active python is running, and any changes to the files you're working on will be ignored.\r\n\r\nYou can check to see if you are working in \"editable mode\" by inspecting the contents of your active virtual environment's `site-packages` folder. In \"editable mode\", you will see a `dallinger.egg-link` file listed in the directory:\r\n```\r\n...\r\ndrwxr-xr-x    9 jesses  staff   306B May 29 12:30 coverage_pth-0.0.2.dist-info\r\n-rw-r--r--    1 jesses  staff    44B May 29 12:30 coverage_pth.pth\r\n-rw-r--r--    1 jesses  staff    33B Jun 14 16:08 dallinger.egg-link\r\ndrwxr-xr-x   21 jesses  staff   714B Mar 19 17:24 datashape\r\ndrwxr-xr-x   10 jesses  staff   340B Mar 19 17:24 datashape-0.5.2.dist-info\r\n...\r\n```\r\nThe contents of this file point will include the path to the working copy that's active:\r\n```\r\n/Users/jesses/py_dev/Dallinger3\r\n.\r\n```\r\nIf you instead see a directory tree with actual dallinger files, you can restore \"editable mode\" by re-running the installation steps for dallinger from the \"Developer Installation\" documentation.\r\n\r\n\r\n\r\n\r\n"}}
{"actor":{"display_login":"witekdev"}}