Bug 57479 - [PATCH] Typo in HSSFWorkbook javaDocs
Summary: [PATCH] Typo in HSSFWorkbook javaDocs
Status: RESOLVED FIXED
Alias: None
Product: POI
Classification: Unclassified
Component: HSSF (show other bugs)
Version: unspecified
Hardware: PC All
: P2 trivial (vote)
Target Milestone: ---
Assignee: POI Developers List
URL:
Keywords: PatchAvailable
Depends on:
Blocks:
 
Reported: 2015-01-21 20:57 UTC by Ahmed Ashour
Modified: 2015-02-09 22:51 UTC (History)
0 users



Attachments
The patch for HSSFWorkbook (580 bytes, application/x-gzip)
2015-01-21 20:57 UTC, Ahmed Ashour
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Ahmed Ashour 2015-01-21 20:57:21 UTC
Created attachment 32387 [details]
The patch for HSSFWorkbook

Hi all,

- Please find attached patch for repeated spelling mistake.

- Also, why the patch.xml doesn't detect changes in src/documentation/content/xdocs/spreadsheet/quick-guide.xml

The below are outdated samples:

    -  NPOIFSFileSytem fs = new NPOIFSFileSystem(new File("file.xls"));
    -  HSSFWorkbook wb = new HSSFWorkbook(fs.getRoot());
    +  NPOIFSFileSystem fs = new NPOIFSFileSystem(new File("file.xls"));
    +  HSSFWorkbook wb = new HSSFWorkbook(fs.getRoot(), true);
       ....
       fs.close();
 
       // HSSFWorkbook, InputStream, needs more memory
    -  NPOIFSFileSytem fs = new NPOIFSFileSystem(myInputStream);
    -  HSSFWorkbook wb = new HSSFWorkbook(fs.getRoot());
    +  NPOIFSFileSystem fs = new NPOIFSFileSystem(myInputStream);
    +  HSSFWorkbook wb = new HSSFWorkbook(fs.getRoot(), true);
Comment 1 Ahmed Ashour 2015-01-21 21:02:59 UTC
Hi again,

- How about 'organize imports' in eclipse?
- How about formatting the source code, as for example, braces location is inconsistent, and the codes doesn't strictly follow http://poi.apache.org/guidelines.html#CodeStyle
Comment 2 Dominik Stadler 2015-02-09 22:51:20 UTC
Fixed via r1658596 and r1658597, thanks for reporting. 

The codebase is slowly being updated to conform to coding standards, however we did not yet perform a full reformat as it would break lots of patches and changes people maintain locally, maybe we will decide to do this in an automated way sometimes.

The documentation is located in a separate SVN repository/path and only linked into the poi working copy via SVN Externals, this likely confuses the patch scripts.

You can just run "svn diff" on the src/documentation folder to get those patches computed.