[ 
https://issues.apache.org/jira/browse/DOXIASITETOOLS-319?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17786634#comment-17786634
 ] 

ASF GitHub Bot commented on DOXIASITETOOLS-319:
-----------------------------------------------

kriegaex commented on PR #118:
URL: 
https://github.com/apache/maven-doxia-sitetools/pull/118#issuecomment-1813899999

   @michael-o, looks good to me. It is not a substantial change, but I think 
the new alias and the improved description might help users.




> Improve (documentation on) DocumentRenderer 
> interface/DocumentRenderingContext class
> ------------------------------------------------------------------------------------
>
>                 Key: DOXIASITETOOLS-319
>                 URL: https://issues.apache.org/jira/browse/DOXIASITETOOLS-319
>             Project: Maven Doxia Sitetools
>          Issue Type: Task
>          Components: Site renderer
>    Affects Versions: 2.0.0-M13
>            Reporter: Michael Osipov
>            Assignee: Michael Osipov
>            Priority: Major
>             Fix For: 2.0.0-M16
>
>
> This is a followup to MSHARED-1326.
> {{#getOutputName()}} does not clearly say that is actually an optional base 
> *path* and base name (base location) of the report item from a reporting 
> output directory. It needs at least a doc update and maybe even a rename to 
> {{#getOutputPath()}}/{{#getOutputPathLocation()}}?
> Same applies for {{#getInputName()}}.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to