Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

no XML docs on anything #454

Closed
brandonh-msft opened this issue Apr 18, 2018 · 4 comments
Closed

no XML docs on anything #454

brandonh-msft opened this issue Apr 18, 2018 · 4 comments
Assignees
@tomlm
Labels
bug Indicates an unexpected problem or an unintended behavior.
Milestone
BUILD 2018

Comments

@brandonh-msft
Copy link
Contributor

There are no XML documentation tags on any of the APIs in the m3.1 nupkgs.
microsoftteams-image
microsoftteams-image 1
@cleemullins cleemullins added the bug Indicates an unexpected problem or an unintended behavior. label Apr 19, 2018
@cleemullins cleemullins added this to the BUILD 2018 milestone Apr 19, 2018
@cleemullins
Copy link
Contributor

Looking at the NuGet packages, it does like as though the XML Doc Tags are not there. This is especially annoying as we have been adding detailed XML Comments to our code for the last several weeks.

@cleemullins
Copy link
Contributor

I've add this to our daily working tracking list to make sure it's in for the MQ Package drop.

@drub0y
Copy link
Contributor

drub0y commented Apr 19, 2018

Yeah, the problem is the <DocumentationFile> property has a Condition to only build for the Documentation specific build configuration only and not Release. There's a couple ways to skin this cat. Options:

  1. Put the <DocumentationFile> property into the Release specific property group - probably simplest for now, but dupes it
  2. Change the condition on the current property group that was created just for <DocumentationFile> so that it evals to true for Release config too - gettin' messy
  3. Introduce a custom property called maybe ShouldBuildDocs with a value of true, put that into the build configuration property groups that want docs to be built, then just put into the base property group and put a condition on it of Condition="'$(ShouldBuildDocs)'!=''".

Finally, I would suggest we also parameterize the <DocumentationFile> property instead of being so hardcoded, so the final property might look like:

<DocumentationFile Condition="'$(ShouldBuildDocs)'!=''">$(OutputPath)$(AssemblyName).xml</DocumentationFile>

@tomlm
Copy link
Contributor

tomlm commented Apr 21, 2018

I just checked in fix for this. thanks

@tomlm tomlm closed this as completed Apr 21, 2018
ShYuPe pushed a commit to ShYuPe/botbuilder-dotnet that referenced this issue Aug 25, 2020
@Virtual-Josh @johnataylor
Merging Teams in so far (microsoft#454)
2bfacd5 
* initial commit for Teams work

* initial commit for Teams

* adding teams activity handler, team info, and teams channel account classes

* adding conversation update scenario

* fixing linting issues

* updating classes to use standard attrs

* cleaning up PR feedback

* adding line

* adding another blank line

* adding mentions bot and fixing bug for resource response IDs

* Threading helper workaround

* Corrected case of "teams" folder name in core.  Corrected __init__.py in schema so TeamsChannelAccount was defined.

* adding mention bot

updating mention bot

cleaning up linter

removing readme, removing self from on_error

* resolving merge conflict

* adding mention bot

cleaning up linter

* updating linting

* adding mention bot

updating mention bot

cleaning up linter

removing readme, removing self from on_error

* resolving merge conflict

* adding mention bot

cleaning up linter

* updating linting

* Added 43.complex-dialog

* Pinned dependencies in all libraries

* adding activity update and delete

* adding list for activities

* cleaning up config

* Pinned dependencies in libraries (missed some setup.py)

* modify echo to work out of the box w/ ARM template

* Added 47.inspection (microsoft#381)

* Added 47.inspection, corrected README in 45.state-management

* Changed the on_error function to be unbound for consistency.

* ChoiceFactory.for_channel was erroneously returning a List instead of an Activity (microsoft#383)

* Refactored to unbound on_error methods when accessing outer app.py va… (microsoft#385)

* Refactored to unbound on_error methods when accessing outer app.py variables.

* Removed unused imports

* Added 16.proactive-messages (microsoft#413)

* Added 19.custom-dialogs (microsoft#411)

* Fix ChoicePrompt ListStyle.none when set via PromptOptions (microsoft#373)

* fix ChoicePrompt none style when set via options

* black compat

* Added 18.bot-authentication (microsoft#419)

* Added 17.multilingual-bot

* Added 23.facebook-events sample

* 23.facebook-events: on_error is now an unbound function

* Partial 15.handling-attachments

* Removing unnecesary encoding

* Added 15.handling-attachments

* 17.multilingual-bot suggested corrections

* 15.handling-attachments suggested corrections

* pylint and black, suggested corrections.

* pylint and black changes.  No logic changes. (microsoft#427)

* Fixes microsoft#425: Using incorrect BotState (microsoft#426)

* Added send_activities and updated the logic

* pylint: Added send_activities and updated the logic

* pylint: Added send_activities and updated the logic

* black formatter: Added send_activities and updated the logic

* Added 11.qnamaker (microsoft#429)

* Added 40.timex resolution (microsoft#430)

* Unfinished push until recognizers-text is updated.

* Added 40.timex-resolution

* Added 42.scaleout (microsoft#435)

* Pinned pytest version (microsoft#438)

* updating linting

* fixing linting

* initial commit for Teams work

* initial commit for Teams

* adding teams activity handler, team info, and teams channel account classes

* adding conversation update scenario

* fixing linting issues

* updating classes to use standard attrs

* cleaning up PR feedback

* adding line

* adding another blank line

* Corrected case of "teams" folder name in core.  Corrected __init__.py in schema so TeamsChannelAccount was defined.

* removing extension file

* resovling conflict

* more merge conflict resolution

* fixing linting

* fixing conflicts

* adding updated teams activity handler

* updating None check

* updating activity handler and fixing spacing issue

* updating activity handler and tests

* updating teams activity handler

* removing constant

* adding tests and removing constant

* moving scenarios to root

* updating attr check, using .seralize(), removing return

* rerunnign black

* updating names

* updating loop to downcast

* member not memeber

* adding s
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tomlm tomlm

Labels
bug Indicates an unexpected problem or an unintended behavior.
Projects
None yet
Milestone
BUILD 2018
Development

No branches or pull requests
4 participants
@drub0y @cleemullins @tomlm @brandonh-msft