Skip to content

Commit e84122b

Browse files
committed
fix comments
1 parent 4d17455 commit e84122b

File tree

1 file changed

+2
-7
lines changed

1 file changed

+2
-7
lines changed

src/library/enigmaxml.lua

+2-7
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,11 @@ end
4040
--[[
4141
% extract_enigmaxml
4242
43-
EnigmaXML is the underlying file format of a Finale `.musx` file. It is undocumented
44-
by MakeMusic and must be extracted from the `.musx` file. There is an effort to document
45-
it underway at the [EnigmaXML Documentation](https://github.com/finale-lua/ziputils-documentation)
46-
repository.
47-
4843
This function extracts the EnigmaXML buffer from a `.musx` file. Note that it does not work with Finale's
4944
older `.mus` format.
5045
5146
@ filepath (string) utf8-encoded file path to a `.musx` file.
52-
: (string) utf8-encoded buffer of xml data containing the EnigmaXml extracted from the `.musx`.
47+
: (string) buffer of EnigmaXml data extracted from the `.musx`. (The xml declaration specifies the encoding, but expect it to be utf8.)
5348
]]
5449
function enigmaxml.extract_enigmaxml(filepath)
5550
local not_supported_message
@@ -67,7 +62,7 @@ function enigmaxml.extract_enigmaxml(filepath)
6762
end
6863

6964
-- Steps to extract:
70-
-- Unzip the `.musx` (which is `.zip` in disguise)
65+
-- Unzip the `.musx` (which is a `.zip` archive in disguise)
7166
-- Run the `score.dat` file through `crypt_enigmaxml_buffer` to get a gzip archive of the EnigmaXML file.
7267
-- Gunzip the extracted EnigmaXML gzip archive into a string and return it.
7368

0 commit comments

Comments
 (0)