flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-9792) Cannot add html tags in options description
Date Wed, 11 Jul 2018 19:53:00 GMT

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

ASF GitHub Bot commented on FLINK-9792:
---------------------------------------

Github user dawidwys commented on a diff in the pull request:

    https://github.com/apache/flink/pull/6312#discussion_r201819059
  
    --- Diff: flink-core/src/main/java/org/apache/flink/configuration/description/BlockElement.java
---
    @@ -0,0 +1,33 @@
    +/*
    + * Licensed to the Apache Software Foundation (ASF) under one
    + * or more contributor license agreements.  See the NOTICE file
    + * distributed with this work for additional information
    + * regarding copyright ownership.  The ASF licenses this file
    + * to you under the Apache License, Version 2.0 (the
    + * "License"); you may not use this file except in compliance
    + * with the License.  You may obtain a copy of the License at
    + *
    + *     http://www.apache.org/licenses/LICENSE-2.0
    + *
    + * Unless required by applicable law or agreed to in writing, software
    + * distributed under the License is distributed on an "AS IS" BASIS,
    + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    + * See the License for the specific language governing permissions and
    + * limitations under the License.
    + */
    +
    +package org.apache.flink.configuration.description;
    +
    +/**
    + * Part of description that represents a block e.g. some text, linebreak or a list.
    + */
    +public interface BlockElement {
    +
    +	/**
    +	 * Transforms itself into String representation using given format.
    +	 *
    +	 * @param formatter formatter to use.
    +	 * @return string representation
    +	 */
    +	String format(Formatter formatter);
    --- End diff --
    
    Added a common parent.


> Cannot add html tags in options description
> -------------------------------------------
>
>                 Key: FLINK-9792
>                 URL: https://issues.apache.org/jira/browse/FLINK-9792
>             Project: Flink
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 1.5.1, 1.6.0
>            Reporter: Dawid Wysakowicz
>            Assignee: Dawid Wysakowicz
>            Priority: Major
>              Labels: pull-request-available
>
> Right now it is impossible to add any html tags in options description, because all "<"
and ">" are escaped. Therefore some links there do not work.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message