Edgewall Software

Changes between Version 1 and Version 2 of Ticket #13056


Ignore:
Timestamp:
Jul 27, 2018, 6:35:06 AM (6 years ago)
Author:
Ryan J Ollos
Comment:

The proposed changes (log:rjollos.git:t13056_hidden_macros)

  • Are backward-compatible
  • Allow hiding a macro help using _description = None

If that change looks okay I'll add tests.

To hide macro documentation based on user permissions we'd need to pass formatter to get_macro_description, so that formatter.req could be used. To be consistent with arguments of other methods we'd have to change: 

- def get_macro_description(self, name):
+ def get_macro_description(self, formatter, name):

I don't have a particular use for that change now, so I'll skip it.

Legend:

Unmodified
Added
Removed
Modified

  • Ticket #13056

    • Property Owner set to Ryan J Ollos
    • Property Status new → assigned
    • Property Milestone next-major-releases → 1.3.4

  • Ticket #13056 – Description

    v1 v2  
    11For "internal use only" macros like WikiMacros#LatestRelease-macro, it would be good to hide from the wiki macro help. We could either hide the macros with no documentation, or have a class attribute that indicates the macro should be hidden.
    22
    3 Another possible application is to hide documentation for that require a permission that the user does not possess.
     3~~Another possible application is to hide documentation for that require a permission that the user does not possess.~~