Skip to content

Conversation

@jjant
Copy link

@jjant jjant commented Oct 11, 2025

  • Remove documentation saying \n is a valid separator, and that key/values are trimmed, as it seems this was a remnant from:
    static PROP_SEPS: &[&str] = &["\r\n", "\n", ";"];
    const DEFAULT_PROP_SEP: char = ';';
    const KV_SEP: &[char] = &['=', ':'];
    const COMMENT_PREFIX: char = '#';
    /// A map of key/value (String,String) properties.
    ///
    /// It can be parsed from a String, using `;` or `<newline>` as separator between each properties
    /// and `=` as separator between a key and its value. Keys and values are trimed.
    #[non_exhaustive]
    #[derive(Clone, PartialEq, Eq, Default)]
    pub struct Properties(pub HashMap<String, String>);
    ,
  • Mention that keys can have multiple values using | as a separator,
  • Fix typo in Parameters::insert and Parameters::is_ordered: extra backtick,
  • Add test/comments for Parameters::values returning empty iterator.

- Remove documentation saying `\n` is a valid separator, as this was a
  remnant from https://github.com/eclipse-zenoh/zenoh/blob/9d564148e438390137d7360014a29cf34779f755/commons/zenoh-cfg-properties/src/lib.rs#L155-L166,
- Mention that keys can have multiple values using `|` as a separator,
- Fix typo in `Parameters::insert` and `Parameters::is_ordered`: extra
  `\``,
- Add test/comments for `Parameters::values` returning empty iterator.
@github-actions
Copy link

PR missing one of the required labels: {'internal', 'api-sync', 'breaking-change', 'enhancement', 'new feature', 'ci', 'bug', 'documentation', 'dependencies'}

@jjant
Copy link
Author

jjant commented Oct 11, 2025

Unclear why eclipsefdn/eca is still failing, I've signed the ECA and linked my GH account in Eclipse.

Maybe the action just needs to be re-ran by someone that has permissions.

@codecov
Copy link

codecov bot commented Oct 12, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.20%. Comparing base (66c3403) to head (ad857cd).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2195      +/-   ##
==========================================
- Coverage   71.32%   71.20%   -0.13%     
==========================================
  Files         375      375              
  Lines       60949    60953       +4     
==========================================
- Hits        43474    43399      -75     
- Misses      17475    17554      +79     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@diogomatsubara diogomatsubara added the documentation Improvements or additions to documentation label Oct 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants