github / github/markup

README.pod symlink to Perl module renders incorrectly

未關閉
#1,253 29 則留言 3 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
Ruby
星號
6k
分支
3.4k
PR 合併指標
30 天內沒有已合併 PR

描述

Opening a new issue in an attempt to shine some light on my last comment in #1158 and the behaviour observed rendering the `README.pod` [here](https://github.com/jhthorsen/applify). I have a mixture of private repositories using the same technique that have a mix of success and failure in displaying the expected result and a minimal example of success [here](https://github.com/kiwiroy/markup-1158-plus)

The symlinks are detected as POD as reported [here](https://github.com/jhthorsen/applify/search?l=Pod).

Running locally `github-markup`, `pod2html` converts as expected:

```console
$ git rev-parse --short HEAD
8f436ff
$ bundle show | grep linguist
* github-linguist (7.1.3)
$ bundle exec bin/github-markup ../applify/README.pod | head

NAME

Applify - Write object oriented scripts with ease

VERSION

0.15

DESCRIPTION


$ perl -v | head -n2 | tail -n1
This is perl 5, version 26, subversion 2 (v5.26.2) built for darwin-thread-multi-2level
```

I did some sanity checking in [linguist](https://github.com/github/linguist/compare/master...kiwiroy:markup-1158) with additional tests, they all passed.

貢獻指南

開啟貢獻指南

研究方向

從連結的 applify 儲存庫中的 README.pod 符號連結開始,將 GitHub 的轉譯結果與此處顯示的本機 `github-markup` 和 `pod2html` 輸出進行比較。檢查 Linguist 中回報的符號連結偵測,以及連結比較中的額外測試;當 README.pod 的內容在 GitHub 上如預期轉譯時,即視為完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
perl, ruby
領域
documentation
Issue 類型
缺陷
難度
4/5
預估耗時
3-5 天
活躍度
冷清
描述清晰度
基本清楚
新手友好度
42/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。