Skip to content

Commit

Permalink
Add notes on missing functionality to primary docstring
Browse files Browse the repository at this point in the history
Namely, missing functionality in ZFS and UNIX-specific macOS system
dirs.  I'd love to get around to implementing these but haven't
yet (it's difficult and I haven't found the time; might as well
document them so people are aware of this and consider trying again
when I have time or if somebody needs the functionality).
  • Loading branch information
jakewilliami committed Jan 13, 2024
1 parent f0cf6cf commit 0f5d579
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/HiddenFiles.jl
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ On Unix-like systems, a file or directory is hidden if it starts with a full sto
!!! note
On macOS, any file or directory within a [package](https://developer.apple.com/library/archive/documentation/CoreFoundation/Conceptual/CFBundles/DocumentPackages/DocumentPackages.html) or a [bundle](https://developer.apple.com/library/archive/documentation/CoreFoundation/Conceptual/CFBundles/AboutBundles/AboutBundles.html) will also be considered hidden.
!!! note
There may be some UNIX-specific system directories in macOS that are not yet classified as hidden ([#18](https://github.com/jakewilliami/HiddenFiles.jl/pull/18)).
!!! note
Mount points on ZFS are not yet classified as hidden ([#20](https://github.com/jakewilliami/HiddenFiles.jl/pull/20)).
"""
ishidden

Expand Down

0 comments on commit 0f5d579

Please sign in to comment.