NotionRubyMapping のマニュアル修正(3) : hkob の雑記録 (185)

はじめに

hkob の雑記録の第185回目は、NotionRubyMapping の FileBlock のマニュアルを修正します。

FileBlock のマニュアル修正

昨日は Page block の set_cover, set_icon の記述を修正しました。Database block も同じなので、今日修正しています。今日は、FileBlock の修正を行います。

hkob.notion.site

これまでと同様に、まずトップの目次はなくしました。右に目次があるためです。目次に戻るリンクを消したので、区切りがわかりにくくなったため、見出し2のメソッド名をオレンジ色背景にしています。その他細かい記述などを修正しています。

FileBlock のマニュアル

self.new の修正

これまでは、FileBlock.new の第一引数は url を受け付けていました。この引数はそのまま FileObject.file_object に渡されます。このクラスメソッドは external url だけでなく、FileUploadObject も受け付けるように修正しています。このため、FileBlock の第一引数もその性質を受け継ぎ、FileUploadObject を受け付けることができます。そのため、このマニュアルでは url_or_fuo という形でどちらも受け付けるという説明に修正しました。

self.new の説明修正

file_upload_object, file_upload_object= の説明

同様に file_upload_object の読み込みおよび設定のメソッドの説明も追記しました。

file_upload_object, file_upload_object= の説明追加

おわりに

FileBlock は FileBaseBlock のサブクラスとなります。このため、同じ親クラスを持つ PDFBlock, VideoBlock なども同じ説明を記述すればよいことになります。このあと同様に修正しておきます。

hkob.notion.site