Bug 31618

Summary:	Typo in POD for C4::ImportBatch::RecordsFromMARCXMLFile
Product:	Koha	Reporter:	Magnus Enger <magnus>
Component:	MARC Bibliographic data support	Assignee:	Sam Lau <samalau>
Status:	RESOLVED FIXED	QA Contact:	Katrin Fischer <katrin.fischer>
Severity:	trivial
Priority:	P5 - low	CC:	lucas, samalau
Version:	Main	Keywords:	Academy
Hardware:	All
OS:	All
Change sponsored?:	---	Patch complexity:	Trivial patch
Documentation contact:		Documentation submission:
Text to go in the release notes:		Version(s) released in:	23.11.00,23.05.02,22.11.08
Circulation function:
Attachments:	Bug 31618: Fix typo in POD for C4::ImportBatch::RecordsFromMARCXMLFile Bug 31618: Fix typo in POD for C4::ImportBatch::RecordsFromMARCXMLFile Bug 31618: Fix typo in POD for C4::ImportBatch::RecordsFromMARCXMLFile

Description Magnus Enger 2022-09-23 13:32:11 UTC

1572 =head2 RecordsFromMARCXMLFile
1573 
1574     my ($errors, $records) = C4::ImportBatch::RecordsFromMARCXMLFile($input_file, $encoding);
1575 
1576 Creates MARC::Record-objects out of the given MARCXML-file.
1577 
1578 @PARAM1, String, absolute path to the ISO2709 file.

The last line should say MARCXML, not ISO2709.

Comment 1 Sam Lau 2023-06-13 15:08:56 UTC

Created attachment 152306 [details] [review]
Bug 31618: Fix typo in POD for C4::ImportBatch::RecordsFromMARCXMLFile

To test:
1) Apply the patch
2) Visit C4::ImportBatch::RecordsFromMARCXMLFile
3) See that in the POD (mine was somewhere around line 1592) the line starting with '@PARAM1' now says '@PARAM1, String, absolute path to the MARCXML file.'
4) Sign off :)

Comment 2 Lucas Gass (lukeg) 2023-06-13 19:46:45 UTC

Created attachment 152323 [details] [review]
Bug 31618: Fix typo in POD for C4::ImportBatch::RecordsFromMARCXMLFile

To test:
1) Apply the patch
2) Visit C4::ImportBatch::RecordsFromMARCXMLFile
3) See that in the POD (mine was somewhere around line 1592) the line starting with '@PARAM1' now says '@PARAM1, String, absolute path to the MARCXML file.'
4) Sign off :)

Signed-off-by: Lucas Gass <lucas@bywatersolutions.com>

Comment 3 Katrin Fischer 2023-06-22 20:21:17 UTC

The git diff was a bit confusing here, as it looks like this POD was changed:

=head2 RecordsFromISO2709File

    my ($errors, $records) = C4::ImportBatch::RecordsFromISO2709File($input_file, $record_type, $encoding);

Reads ISO2709 binary porridge from the given file and creates MARC::Record-objects out of it.

@PARAM1, String, absolute path to the ISO2709 file.
@PARAM2, String, see stage_file.pl
@PARAM3, String, should be utf8

Returns two array refs.

=cut

But it's actually this one:

=head2 RecordsFromMARCXMLFile

    my ($errors, $records) = C4::ImportBatch::RecordsFromMARCXMLFile($input_file, $encoding);

Creates MARC::Record-objects out of the given MARCXML-file.

@PARAM1, String, absolute path to the MARCXML file.
@PARAM2, String, should be utf8

Returns two array refs.

=cut

So we are good! Welcome Sam to the Koha devs!

Comment 4 Katrin Fischer 2023-06-22 20:21:53 UTC

Created attachment 152589 [details] [review]
Bug 31618: Fix typo in POD for C4::ImportBatch::RecordsFromMARCXMLFile

To test:
1) Apply the patch
2) Visit C4::ImportBatch::RecordsFromMARCXMLFile
3) See that in the POD (mine was somewhere around line 1592) the line starting with '@PARAM1' now says '@PARAM1, String, absolute path to the MARCXML file.'
4) Sign off :)

Signed-off-by: Lucas Gass <lucas@bywatersolutions.com>
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>

Comment 5 Tomás Cohen Arazi (tcohen) 2023-06-23 13:01:41 UTC

Pushed to master for 23.11.

Nice work everyone, thanks!

Comment 6 Sam Lau 2023-06-23 15:04:54 UTC

(In reply to Katrin Fischer from comment #3)

> So we are good! Welcome Sam to the Koha devs!

Thanks, Katrin!

Comment 7 Martin Renvoize (ashimema) 2023-07-17 14:02:45 UTC

Thanks for all the hard work!

Pushed to 23.05.x for the next release

Comment 8 Pedro Amorim 2023-07-18 11:54:20 UTC

Nice work everyone!

Pushed to 22.11.x for next release