clean up notes

Author: jamestrew

lua/plenary/path2.lua

@@ -1,78 +1,6 @@
---- NOTES:
---- Rework on plenary.Path with a focus on better cross-platform support
---- including 'shellslash' support.
---- Effort to improve performance made (notably `:absolue` ~2x faster).
----
----
---- BREAKING CHANGES:
---- - `Path.new` no longer supported (think it's more confusing that helpful
----   and not really used as far as I can tell)
----
---- - `Path.new` drops `sep` table param (eg. `Path:new {"foo\\bar/baz", sep = "/"}`)
----
---- - drop `__concat` metamethod? it was untested and had some todo comment,
----   not sure how functional it is
----
---- - `Path` objects are now "read-only", I don't think people were ever doing
----   things like `path.filename = 'foo'` but now explicitly adding some barrier
----   to this. Allows us to compute `filename` from "metadata" parsed once on
----   instantiation.
----
---- - FIX: `Path:make_relative` throws error if you try to make a path relative
----   to another path that is not in the same subpath.
----
----   eg. `Path:new("foo/bar_baz"):make_relative("foo/bar")` => errors as you
----   can't get to "foo/bar_baz" from "foo/bar" without going up in directory.
----   This would previously return "foo/bar_baz" which is wrong.
----
----   Adds an option to walk up path to compensate.
----
----   eg. `Path:new("foo/bar_baz"):make_relative("foo/bar", true)` => returns
----   "../bar_baz"
----
---- - error handling is generally more loud, ie. emit errors from libuv rather
----   than swallowing it
----
---- - remove `Path:normalize`. It doesn't make any sense. eg. this test case
----   ```lua
----   it("can normalize ~ when file is within home directory (trailing slash)", function()
----     local home = "/home/test/"
----     local p = Path:new { home, "./test_file" }
----     p.path.home = home
----     p._cwd = "/tmp/lua"
----     assert.are.same("~/test_file", p:normalize())
----   end)
----   ```
----   if the idea is to make `/home/test/test_file` relative to `/tmp/lua`, the result
----   should be `../../home/test/test_file`, only then can you substitue the
----   home directory for `~`.
----   So should really be `../../~/test_file`. But using `~` in a relative path
----   like that looks weird to me. And as this function first makes paths
----   relative, you will never get a leading `~` (since `~` literally
----   represents the absolute path of the home directory).
----   To top it off, something like `../../~/test_file` is impossible on Windows.
----   `C:/Users/test/test_file` relative to `C:/Windows/temp` is
----   `../../Users/test/test_file` and there's no home directory absolute path
----   in this.
----
---- - `rename` returns new path rather than mutating path
----
---- - `copy`
----   - drops interactive mode
----   - return value table is pre-flattened
----   - return value table value is `{success: boolean, err: string?}` rather than just `boolean`
----
---- - drops `check_self` mechanism (ie. doing `Path.read("some/file/path")`)
----   seems unnecessary... just do `Path:new("some/file/path"):read()`
----
---- - renamed `iter` into `iter_lines` for more clarity
----
---- - `find_upwards` returns `nil` if file not found rather than an empty string
-
--- TODO: add windows test for path2_spec only?
-
 local bit = require "plenary.bit"
 local uv = vim.loop
+
 local iswin = uv.os_uname().sysname == "Windows_NT"
 local hasshellslash = vim.fn.exists "+shellslash" == 1