packages feed

open-browser 0.3.0.0 → 0.3.0.1

raw patch · 6 files changed

+59/−49 lines, 6 filessetup-changedPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

CHANGELOG.md view
@@ -6,6 +6,11 @@ and this project adheres to the
 [Haskell Package Versioning Policy](https://pvp.haskell.org/).
 
+## 0.3.0.1 - 2025-03-17
+
+* On Windows, remove unnecessary dependency on `process`.
+* Improve Haddock documentation.
+
 ## 0.3.0.0 - 2025-03-16
 
 * Make operating system-related choices at compilation. The function will never
LICENSE view
@@ -1,30 +1,30 @@-Copyright (c) 2015, rightfold--All rights reserved.--Redistribution and use in source and binary forms, with or without-modification, are permitted provided that the following conditions are met:--    * Redistributions of source code must retain the above copyright-      notice, this list of conditions and the following disclaimer.--    * Redistributions in binary form must reproduce the above-      copyright notice, this list of conditions and the following-      disclaimer in the documentation and/or other materials provided-      with the distribution.--    * Neither the name of rightfold nor the names of other-      contributors may be used to endorse or promote products derived-      from this software without specific prior written permission.--THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.+Copyright (c) 2015, rightfold
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of rightfold nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
README.md view
@@ -1,9 +1,9 @@-# open-browser--A Haskell library that provides the function `openBrowser` that, given a URL,-yields an IO action that seeks to open the URL in the user's preferred web-browser.--Supported operating systems are Windows, macOS, Linux and BSD.--Originally developed by rightfold.+# open-browser
+
+A Haskell library that provides the function `openBrowser` that, given a URL or
+other item associated with a web browser, yields an IO action that seeks to open
+the item in the user's preferred web browser.
+
+Supported operating systems are Windows, macOS, Linux and BSD.
+
+Originally developed by rightfold.
Setup.hs view
@@ -1,2 +1,2 @@-import Distribution.Simple-main = defaultMain+import Distribution.Simple
+main = defaultMain
lib/Web/Browser.hs view
@@ -15,15 +15,21 @@ 
 import qualified Web.Browser.OS as OS
 
--- | Seeks to open the given URL in the user's preferred web browser. Returns
--- whether or not the operation succeeded. No checks are performed on the
--- validity of the given URL.
+-- | Seeks to open the given item. If the item is a URL or another item
+-- associated with a web browser (for example, it represents a local @.html@
+-- file), seeks to open it in the user's preferred web browser. Returns whether
+-- or not the operation succeeded.
 --
+-- No checks are performed on the nature or validity of the given item.
+--
 -- Implemented using:
 --
--- * on Windows, the \'open\' operation provided by the Win32 API;
+-- * on Windows, the \'open\' operation provided by the Win32 API. For an item
+--   that represents a file, equivalent double-clicking on the file's icon;
 --
--- * on macOS, the \'open\' application, if it is on the user's PATH; and
+-- * on macOS, the \'open\' application, if it is on the user's PATH. For an
+--   item that represents a file, equivalent to double-clicking on the file's
+--   icon; and
 --
 -- * on Linux, FreeBSD, OpenBSD or NetBSD, the \'xdg-open\' application, if it
 --   is on the user's PATH, via \'sh\' to allow the application's output to be
@@ -32,6 +38,6 @@ -- On other operating systems, the operation always fails.
 openBrowser ::
      String
-     -- ^ URL
+     -- ^ URL or other item to try to open
   -> IO Bool
 openBrowser = OS.openBrowser
open-browser.cabal view
@@ -5,7 +5,7 @@ -- see: https://github.com/sol/hpack  name:           open-browser-version:        0.3.0.0+version:        0.3.0.1 synopsis:       Open a web browser from Haskell description:    Open a web browser from Haskell. Windows, macOS, Linux and BSD are supported. category:       Web@@ -40,7 +40,6 @@       Web.Browser   build-depends:       base ==4.*-    , process >=1.4.3.0 && <2   default-language: Haskell2010   if os(windows)     other-modules: