Unidata / netcdf-java

The Unidata netcdf-java library
https://docs.unidata.ucar.edu/netcdf-java/current/userguide/index.html
BSD 3-Clause "New" or "Revised" License
145 stars 70 forks source link

Documentation for unescaping names references missing method #219

Open tayloj opened 4 years ago

tayloj commented 4 years ago

In 5.2.0, the documentation for NetcdfFile.findVariable says:

Find a Variable, with the specified (escaped full) name.It may possibly be nested in multiple groups and/or structures.An embedded "." is interpreted as structure.member.An embedded "/" is interpreted as group/variable.If the name actually has a ".", you must escape it (call NetcdfFile.escapeName(varname))Any other chars may also be escaped, as they are removed before testing.

However, there is no NetcdfFile.escapeName(String) method (anymore; I assume that there used to be). The name related methods are:

NetcdfFile.makeNameUnescaped(String)
NetcdfFile.makeValidCDUName(String)
NetcdfFile.makeValidCdmObjectName(String)
NetcdfFile.makeValidPathName(String)
NetcdfFile.makeValidSectionSpecName(String)

The Javadoc should be updated in whatever way is appropriate. (I was able to just escape . in the names and was fine, so this is not a blocker for me).

JohnLCaron commented 4 years ago

This has already been changed in 5.3 to:

/**

So I htink this can be closed.

RyanJHeld commented 3 years ago

I'm having the same issue. @JohnLCaron , what you have pasted there also references NetcdfFiles.makeValidPathName. The method actually still exists in 5.4.1, but now it's private. The docs still need to be updated.