question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add basic project documentation and example usage

See original GitHub issue

Written and edited by @CAM-Gerlach (OP was initially empty):

  • Add/move general information currently contained in __init__ docstring to the README for visibility
  • Clarify that QtPy follows PyQt5 conventions, and link Qt and PyQt5 API docs
  • Add examples of using QtPy in place of the specific bindings
  • List/describe the methods/helpers specific to QtPy (listed in #61 )
    • from qtpy.QtCore import Signal, Slot
    • QFileDialog helpers
    • qtpy.QtCore.__version__
    • Others?
  • Document the QtPy-specific environment variables (FORCE_QT_API, etc)
  • Describe the main package-level constants (PYQT5, PYSIDE2, etc)
  • Clarify the benefits of using QtPy with regard to cross-Qt-version migration, and link success stories (described in #62 )
  • Clarify Qt version compatibility in the readme

Issue Analytics

  • State:open
  • Created 7 years ago
  • Comments:13 (11 by maintainers)

github_iconTop GitHub Comments

2reactions
CAM-Gerlachcommented, Nov 5, 2021

As another low-hanging fruit item, the __init__.py contains a substantial amount of general information and examples in its docstring that could be moved to or included in the README to be much more visible, with a bit of cleanup.

1reaction
CAM-Gerlachcommented, Nov 8, 2021

Thanks, opened as PR #279

Read more comments on GitHub >

github_iconTop Results From Across the Web

Project Documentation: Examples and Templates - Nuclino
Examples of project documents · Project proposal · Project charter · Project plan · Project status report · Project retrospective · Other project...
Read more >
How to Write Project Documentation in 5 Easy Steps
Here is a step-by-step explanation of the writing project documentation. Read this blog to understand how to use free project documentation ...
Read more >
15 Essential Project Documents - ProjectManager
Project documentation has several purposes such as project planning, cost management or risk management. In addition, there are certain project ...
Read more >
The documents you MUST create for any project
We'll look at 11 essential project documents you need for ANY project. Including purpose and with downloadable template.
Read more >
How to Create Project Documentation with Examples & Benefits
It's important to start with a project documentation definition. Project documentation is very simple. It's a collection of all the documents ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found