[Commit-gnuradio] [gnuradio] 04/10: pmt::is_dict() and is_pair() both return true for both dictionaries and pairs. This causes issues as one may believe they have a dictionary pmt and attempt to reference it's keys (which will throw an exception for a pair). This simply serves to document this behavior

[git]

This is an automated email from the git hooks/post-receive script.

jcorgan pushed a commit to branch maint
in repository gnuradio.

commit a780a9eb53132356c3da9fdd22548846ccfdedd9
Author: Jacob Gilbert <address@hidden>
Date:   Thu Mar 10 21:12:35 2016 -0800

    pmt::is_dict() and is_pair() both return true for both dictionaries and 
pairs. This causes issues as one may believe they have a dictionary pmt and 
attempt to reference it's keys (which will throw an exception for a pair). This 
simply serves to document this behavior
---
 gnuradio-runtime/include/pmt/pmt.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/gnuradio-runtime/include/pmt/pmt.h 
b/gnuradio-runtime/include/pmt/pmt.h
index f601c85..00564cc 100644
--- a/gnuradio-runtime/include/pmt/pmt.h
+++ b/gnuradio-runtime/include/pmt/pmt.h
@@ -279,7 +279,7 @@ PMT_API std::complex<double> to_complex(pmt_t z);
 //! Return true if \p x is the empty list, otherwise return false.
 PMT_API bool is_null(const pmt_t& x);
 
-//! Return true if \p obj is a pair, else false.
+//! Return true if \p obj is a pair, else false (warning: also returns true 
for a dict)
 PMT_API bool is_pair(const pmt_t& obj);
 
 //! Return a newly allocated pair whose car is \p x and whose cdr is \p y.
@@ -575,7 +575,7 @@ PMT_API std::complex<double> 
*c64vector_writable_elements(pmt_t v, size_t &len);
  * ------------------------------------------------------------------------
  */
 
-//! Return true if \p obj is a dictionary
+//! Return true if \p obj is a dictionary (warning: also returns true for a 
pair)
 PMT_API bool is_dict(const pmt_t &obj);
 
 //! Make an empty dictionary