From aa262561356db99603ce3d610291d27eb5881b17 Mon Sep 17 00:00:00 2001 From: Christopher Denter Date: Sun, 30 Jan 2011 19:20:30 +0100 Subject: [PATCH] docs: warn users that core image != widget image --- doc/sources/guide/architecture.rst | 2 ++ kivy/core/__init__.py | 9 +++++++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/sources/guide/architecture.rst b/doc/sources/guide/architecture.rst index d1e702262..af700f1b6 100644 --- a/doc/sources/guide/architecture.rst +++ b/doc/sources/guide/architecture.rst @@ -14,6 +14,8 @@ Kivy consists of several building blocks that we will explain in the following. +.. _providers: + Core Providers and Input Providers ---------------------------------- diff --git a/kivy/core/__init__.py b/kivy/core/__init__.py index 7aae6ca7d..896fd3eba 100644 --- a/kivy/core/__init__.py +++ b/kivy/core/__init__.py @@ -4,13 +4,18 @@ Core Abstraction This module defines the abstraction layers for our core providers and their implementations. For further information, please refer to -`Architectural Overview` and the `Core Providers and Input Providers` section -of the documentation. +:ref:`architecture` and the :ref:`providers` section of the documentation. In most cases, you shouldn't directly use a library that's already covered by the core abstraction. Always try to use our providers first. In case we are missing a feature or method, please let us know by opening a new Bug report instead of relying on your library. + + **Note:** + These are **not** widgets! These are just abstractions of the respective + functionality. For example, you cannot add a core image to your window. + You have to use the image **widget** class instead. If you're really + looking for widgets, please refer to :mod:`kivy.uix` instead. ''' import os