zeek / zeek-docs

Documentation for Zeek
https://docs.zeek.org
Other
50 stars 70 forks source link

Params in function documentation upper-cased #187

Closed awelzel closed 1 year ago

awelzel commented 1 year ago

Somewhere in the process from zeekygen to rst to html, the parameter names in function docs is upper-cased and it looks a bit strange:

Screenshot-20230516-132637

Concrete and confusing example was from_json(s: string, t: any) where t currently ends-up as T.

The intermediate .rst files somehow use the parameter names as roles or options (?) directly.

   Disables the analyzer which raised the current event (if the analyzer
   belongs to the given connection).

   :cid: The connection identifier.

   :aid: The analyzer ID.

   :err_if_no_conn: Emit an error message if the connection does not exit.

Think we should either have zeekygen generate them as **cid**, or ``:zeek:param:cid```` style.