From ed45238fb964fe77199254b9d6917f2e5e2cf1c6 Mon Sep 17 00:00:00 2001 From: Harry Garrood Date: Sat, 22 Feb 2020 23:59:09 +0000 Subject: [PATCH] Explain how to get hold of a `Document` Resolves #19 --- .gitignore | 1 + src/Web/DOM/Document.purs | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/.gitignore b/.gitignore index 709fd09..bd06561 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ package-lock.json /bower_components/ /node_modules/ /output/ +/generated-docs/ diff --git a/src/Web/DOM/Document.purs b/src/Web/DOM/Document.purs index fe83b76..8fbb3d8 100644 --- a/src/Web/DOM/Document.purs +++ b/src/Web/DOM/Document.purs @@ -1,3 +1,11 @@ +-- | This module provides type definitions and implementations for the +-- | `Document` interface, which is part of the W3C DOM API. +-- | +-- | The DOM API doesn't actually give you any way of getting hold of a +-- | `Document` by itself. To do that, you will need to look at one of the +-- | other APIs which build on the DOM API. For example, `window.document` is +-- | part of the HTML5 API, and so the relevant binding can be found in +-- | `Web.HTML.Window`, which is part of the `purescript-web-html` package. module Web.DOM.Document ( Document , fromNode