bugGNU Scientific Library - Bugs: bug #36578, inconsistency in...

 
 

You are not allowed to post comments on this tracker with your current authentification level.

bug #36578: inconsistency in gsl_ieee_env_setup doc/api

Submitted by:  Rhys Ulerich <rhysu>
Submitted on:  Sat 02 Jun 2012 05:41:51 PM UTC  
 
Category: DocumentationSeverity: 3 - Normal
Operating System: Status: None
Assigned to: Rhys Ulerich <rhysu>Open/Closed: Open
Release: 

Sat 02 Jun 2012 05:41:51 PM UTC, original submission:

---8<---
This line from the gsl_ieee_env_setup() documentation
(http://www.gnu.org/software/gsl/manual/html_node/Setting-up-your-IEEE-environment.html)
makes no sense

> If the requested modes are not supported by the platform
> being used then the function calls the error handler and
> returns an error code of GSL_EUNSUP.


as the relevant function signature is

> void gsl_ieee_env_setup (void)


The GSL_EUNSUP value is returned from gsl_ieee_set_mode within
gsl_ieee_env_setup's implementation, but the value is ignored and not
returned to the caller.

So:

a) Fix the documentation. Easy.

b) Fix the API signature and implementation. Presumably everyone's
ignoring the currently void return value anyhow and changing the
signature to return an int would harm no one.

Thoughts?

- Rhys
---8<---
Thread at http://lists.gnu.org/archive/html/bug-gsl/2012-06/msg00000.html

Rhys Ulerich <rhysu>
Project AdministratorIn charge of this item.

 

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by rhysu (Submitted the item)
  •  

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    No Changes Have Been Made to This Item

    Back to the top


    Powered by Savane 3.1-cleanup