The quote should be part of the userscript's --help page if it's so prominent.
It's very unlikely that anyone will execute the userscript from within the qutebrowser environment with the --help flag (and subsequently check the output using :messages), but much more likely that someone will take a look at the userscript and see that comment. Calling the userscript from outside a qutebrowser environment will fail immediately due to missing environment variables. Why is this an issue with the section and not rather, if at all, a bug report in the qutebrowser repository? --Cryzed (talk) 21:38, 16 November 2017 (UTC)
- I'd say it is highly unlikely that qutebrowser's developer would accept a change which introduces duplication in the documentation, so I don't see why the wiki should do otherwise. I hope the scripts options are not supposed to be discovered only by reading the source code. If the usage of each userscript is not very clear, the interface should be improved. For example, running the script with
--helpfrom the terminal should not result in an error due to missing environment variables, but rather, if the environment is wrong, the help page should be printed implicitly. Then you can simply instruct users to run the script in terminal to know all about it, without any external documentation.
- Anyway, since you seem to be the author of the userscript, consider this to be the bug report ;-)
- -- Lahwaacz (talk) 06:52, 17 November 2017 (UTC)
- > I hope the scripts options are not supposed to be discovered only by reading the source code.
- That's exactly the case, just like with all the other userscripts: they all have their usages, dependencies, documentation etc. outlined in their comment headers, not in any help pages -- mine just happens to use a proper argument parser that can display a help page on request. Maybe it's assumed that people who use qutebrowser are mostly tinkeres anyways and thus don't really mind taking a quick look at a script's source to figure out what it does.
- > Anyway, since you seem to be the author of the userscript, consider this to be the bug report ;-)
- Right, I got that part. I was just wondering why you would create it here in the first place, instead of through the proper channels ;-). Your requested changes can already be found here for now; I'll see about creating a matching pull request. --Cryzed (talk) 11:36, 17 November 2017 (UTC)
Importing bookmarks from Firefox requires python-beautifulsoup4
Taking qutebrowser for a spin. Following the Wiki:
$ python /usr/share/qutebrowser/scripts/importer.py bookmarks.html >> ~/.config/qutebrowser/quickmarks
Results in this:
Traceback (most recent call last): File "/usr/share/qutebrowser/scripts/importer.py", line 351, in <module> main() File "/usr/share/qutebrowser/scripts/importer.py", line 83, in main import_function[input_format](args.bookmarks, bookmark_types, File "/usr/share/qutebrowser/scripts/importer.py", line 198, in import_netscape_bookmarks import bs4 ModuleNotFoundError: No module named 'bs4'