The _aggregator_parse_opml() contains HTML tags that are escaped and appears in the text; they should be probably removed, or replaced by the correct Doxygen tag, if such tag exists.

Parse an OPML file.

Feeds are recognized as <outline> elements with the attributes
<em>text</em> and <em>xmlurl</em> set.

Parameters

$opml
The complete contents of an OPML document.

Return value

An array of feeds, each an associative array with a <em>title</em> and
a <em>url</em> element, or NULL if the OPML document failed to be parsed.
An empty array will be returned if the document is valid but contains
no feeds, as some OPML documents do.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

jhodgdon’s picture

Issue tags: +Novice

Thanks for reporting! Good project for a novice doc contributor to clean up this doc.

apaderno’s picture

Issue tags: +Quick fix
apaderno’s picture

Title: _aggregator_parse_opml() documentation contain escaped HTML tags » _aggregator_parse_opml() documentation contains escaped HTML tags that should be removed

I fixed a typo, and made the title more explicit.

amateescu’s picture

amateescu’s picture

Status: Active » Needs review
apaderno’s picture

Status: Needs review » Reviewed & tested by the community

The test bot is happy and so am I.

jhodgdon’s picture

Status: Reviewed & tested by the community » Needs work

Those EM tags were put in for the purpose of highlighting/setting off those words. Perhaps they should be replaced by quotes? I think that would be a good idea.

montesq’s picture

Status: Needs work » Needs review
FileSize
1.02 KB

Here is the patch with double quotes instead of <em>. Moreover, I think the tag <outline> should not be removed as it's not an html tag but it explains how is formed the opml file.

apaderno’s picture

Status: Needs review » Reviewed & tested by the community
Moreover, I think the tag

should not be removed as it's not an html tag but it explains how is formed the opml file.

That is what I think too; it is the reason the title makes reference to HTML tags.

jhodgdon’s picture

Status: Reviewed & tested by the community » Needs work

When text is removed from the last paragraph, the paragraph needs to be rewrapped:

+ *   An array of feeds, each an associative array with a "title" and a "url" 
+ *   element, or NULL if the OPML document failed to be parsed.
  *   An empty array will be returned if the document is valid but contains

A few words should be moved up to the previous line. Otherwise, I think this patch is fine.

montesq’s picture

Status: Needs work » Needs review
FileSize
1.2 KB

Hope this one is the finale one.
Thx for your remarks

apaderno’s picture

Do we put an empty line between the last @param and @return?

jhodgdon’s picture

Status: Needs review » Needs work

Yes, the empty line between the last @param and the @return is correct in this patch.

This new patch has some spaces at the ends of the lines in the last paragraph. Those need to go...

montesq’s picture

Status: Needs work » Needs review
FileSize
1.19 KB
jhodgdon’s picture

Status: Needs review » Needs work

The first changed line still ends in a space, I think?

You can configure most code-oriented text editors to show whitespace at ends of lines. That will help. In my Emacs, for instance, it is bright red and hard to miss! :)

montesq’s picture

Oh, I'm sorry...
I also use emacs but I didn't notice that. I need to check if this kind of configuration is in place on my personnal compture...
Moreover you talk about the last paragraph, so I didn't look at the beginning of the patch ^^

montesq’s picture

Status: Needs work » Needs review
jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Thanks! Now it looks good.

Emacs: put this in your emacs config file (.emacs etc. depending on platform):
'(show-trailing-whitespace t)

montesq’s picture

@jhodgdon
nice tip! Many Thanks

webchick’s picture

Status: Reviewed & tested by the community » Fixed

Committed to HEAD. Thanks!

Status: Fixed » Closed (fixed)
Issue tags: -Quick fix, -Novice

Automatically closed -- issue fixed for 2 weeks with no activity.