minor doc tweaks (#265)

Author: almarklein

README.md

@@ -4,7 +4,7 @@
 
 # wgpu-py
 
-Next generation GPU API for Python
+A Python implementation of WebGPU - the next generation GPU API.
 
 <img width=300 src='https://user-images.githubusercontent.com/3015475/159725890-5656204b-648b-4f6f-88d5-a656d8ad00c6.png' />
 <img width=300 src='https://user-images.githubusercontent.com/3015475/159726895-2c0cbc7b-ed0a-4cd3-a90c-dd579977eaa4.png' />
@@ -28,7 +28,7 @@ To get an idea of what this API looks like have a look at [triangle.py](https://
 
 *The wgpu-API has not settled yet, use with care!*
 
-* Coverage of the WebGPU spec is nearly complete.
+* Coverage of the WebGPU spec is complete enough to build e.g. [pygfx](https://github.com/pygfx/pygfx).
 * Test coverage of the API is 100%.
 * Support for Windows, Linux, and MacOS (Intel and M1).
 * Until WebGPU settles as a standard, its specification

docs/guide.rst

@@ -5,37 +5,39 @@ Guide
 Not a lot here yet. More will come over time.
 
 
-A brief history of WGPU
------------------------
+A brief history of WebGPU
+-------------------------
 
 For years, OpenGL has been the only cross-platform API to talk to the GPU.
 But over time OpenGL has grown into an inconsistent and complex API ...
 
     *OpenGL is dying*
     --- Dzmitry Malyshau at `Fosdem 2020 <https://fosdem.org/2020/schedule/event/rust_webgpu/>`_
 
-In recent years, modern API's have emerged that solve many of OpenGL's problems.
-You may have heard of them: Vulkan, Metal, and DX12. These API's are
-much closer to the hardware. Unfortunately, the huge amount of "knobs
-to turn" makes them quite hard to work with for developers.
+In recent years, modern API's have emerged that solve many of OpenGL's
+problems. You may have heard of them: Vulkan, Metal, and DX12. These
+API's are much closer to the hardware, which makes the drivers more
+consistent and reliable. Unfortunately, the huge amount of "knobs to
+turn" also makes them quite hard to work with for developers.
 
 Therefore, people are working on a higher level API, that wraps Vulkan/Metal/DX12,
-and uses the same principals, but is much easier to work with. This is the
-`WebGPU spec <https://gpuweb.github.io/gpuweb/>`_. This is what future devs
+using the same concepts, but is much easier to work with. This is the
+`WebGPU specification <https://gpuweb.github.io/gpuweb/>`_. This is what future devs
 will be using to write GPU code for the browser. And for desktop and mobile.
 
-As WebGPU spec is being developed, a reference implementation is also
-being build. It's written in Rust, and is powering the WebGPU implementation in Firefox.
-This reference implementation, called `wgpu-native <https://github.com/gfx-rs/wgpu>`_,
-also exposes a C-api, which means that it can be wrapped in Python. And this is what
-wgpu-py does.
+As the WebGPU spec is being developed, a reference implementation is
+also build. It's written in Rust and powers the WebGPU implementation in Firefox.
+This reference implementation, called `wgpu <https://github.com/gfx-rs/wgpu>`_,
+also exposes a C-api (via `wgpu-native <https://github.com/gfx-rs/wgpu-native>`_),
+so that it can be wrapped in Python. And this is precisely what wgpu-py does.
 
-So in short, wgpu-py is a Python wrapper of wgpu-native, which is a wrapper
-for Vulkan, Metal and DX12, which are low-level API's to talk to the GPU hardware.
+So in short, wgpu-py is a Python wrapper of wgpu, which is an desktop
+implementation of WebGPU, an API that wraps  Vulkan, Metal and DX12,
+which talk to the GPU hardware.
 
 
-Getting started with WGPU
--------------------------
+Getting started with WebGPU
+---------------------------
 
 For now, we'll direct you to some related tutorials:
 

docs/index.rst

@@ -1,10 +1,5 @@
-.. wgpu-py documentation master file, created by
-   sphinx-quickstart on Fri Apr  3 14:28:56 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to wgpu-py's documentation!
-===================================
+Welcome to the wgpu-py docs!
+==============================
 
 .. automodule:: wgpu
 

docs/start.rst

@@ -33,7 +33,7 @@ About this API
 
 This library presents a Pythonic API for the `WebGPU spec
 <https://gpuweb.github.io/gpuweb/>`_. It is an API to control graphics
-hardware. Like OpenGL, but modern.
+hardware. Like OpenGL but modern, or like Vulkan but higher level.
 GPU programming is a craft that requires knowledge of how GPU's work.
 See the guide for more info and links to resources.
 

wgpu/__init__.py

@@ -1,5 +1,5 @@
 """
-This a Python implementation of the next generation GPU API.
+The wgpu library is a Python implementation of WebGPU.
 """
 
 from ._coreutils import logger  # noqa: F401,F403